|
Primavera Integration API Release 8 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.RiskMatrix
public class RiskMatrix
The risk matrix object contains the name and description of each probability and impact diagram (PID). The Risk Matrix is then used to qualitatively assess each risk and assign a score.
See Also: Quick reference of RiskMatrix fields
Constructor Summary | |
---|---|
RiskMatrix(Session session)
Class constructor specifying the Session. |
|
RiskMatrix(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
RiskMatrix(Session session,
com.primavera.infr.db.PrmRowSet rowSet,
int iIndex)
Class constructor called internally after objects are retrieved from the server. |
Method Summary | |
---|---|
ObjectId |
create()
Creates this RiskMatrix object in the database. |
static ObjectId[] |
create(Session session,
RiskMatrix[] riskmatrices)
Creates multiple RiskMatrix objects in the database. |
ObjectId |
createRiskMatrixScore(RiskMatrixScore riskmatrixscore)
Creates an associated RiskMatrixScore object in the database. |
ObjectId[] |
createRiskMatrixScores(RiskMatrixScore[] riskmatrixscores)
Creates multiple associated RiskMatrixScore objects in the database. |
ObjectId |
createRiskMatrixThreshold(RiskMatrixThreshold riskmatrixthreshold)
Creates an associated RiskMatrixThreshold object in the database. |
ObjectId[] |
createRiskMatrixThresholds(RiskMatrixThreshold[] riskmatrixthresholds)
Creates multiple associated RiskMatrixThreshold objects in the database. |
void |
delete()
Deletes this RiskMatrix object from the database. |
static void |
delete(Session session,
RiskMatrix[] riskmatrices)
Deletes multiple RiskMatrix objects from the database. |
void |
deleteRiskMatrixScores(RiskMatrixScore[] riskmatrixscores)
Deletes multiple associated RiskMatrixScore objects from the database. |
void |
deleteRiskMatrixThresholds(RiskMatrixThreshold[] riskmatrixthresholds)
Deletes multiple associated RiskMatrixThreshold objects from the database. |
static String[] |
getAllFields()
Gets all fields for this business object. |
Date |
getCreateDate()
Gets the date this risk matrix was created. |
String |
getCreateUser()
Gets the name of the user that created the risk matrix. |
static String[] |
getDefaultXMLExportFields()
Deprecated. |
String |
getDescription()
Gets the description of the risk matrix. |
static String[] |
getFilterableFields()
Gets all fields that can be filtered. |
int |
getImpactThresholdLevel()
Gets the number of levels for the impact thresholds assigned to the risk scoring matrix. |
static String[] |
getInternalAllFields()
An internal method that should not be called directly by client code. |
static Set<String> |
getInternalAllFieldsSet()
An internal method that should not be called directly by client code. |
static String[] |
getInternalDefaultLoadFields()
An internal method that should not be called directly by client code. |
Date |
getLastUpdateDate()
Gets the date this risk matrix was last updated. |
String |
getLastUpdateUser()
Gets the name of the user that last updated the risk matrix. |
static String[] |
getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter |
String |
getName()
Gets the name of the risk matrix. |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
int |
getProbabilityThresholdLevel()
Gets the number of levels for the probability threshold assigned to the risk matrix. |
static String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
RiskScoreMatrixMethod |
getRiskScoringMethod()
Gets the calculation method used to determine the risk score. |
static String[] |
getWritableFields()
Gets all writable fields for this business object. |
static RiskMatrix |
load(Session session,
String[] fields,
ObjectId objId)
Loads a single RiskMatrix object from the database. |
static BOIterator<RiskMatrix> |
load(Session session,
String[] fields,
ObjectId[] objIds)
Loads multiple RiskMatrix objects from the database. |
BOIterator<Project> |
loadProjects(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated Project objects from the database. |
BOIterator<RiskMatrixScore> |
loadRiskMatrixScores(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated RiskMatrixScore objects from the database. |
BOIterator<RiskMatrixThreshold> |
loadRiskMatrixThresholds(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated RiskMatrixThreshold objects from the database. |
void |
setDescription(String s)
Sets the description of the risk matrix. |
void |
setName(String s)
Sets the name of the risk matrix. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setRiskScoringMethod(RiskScoreMatrixMethod enm)
Sets the calculation method used to determine the risk score. |
String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this RiskMatrix object in the database. |
static void |
update(Session session,
RiskMatrix[] riskmatrices)
Updates multiple RiskMatrix objects in the database. |
void |
updateRiskMatrixScores(RiskMatrixScore[] riskmatrixscores)
Updates multiple associated RiskMatrixScore objects in the database. |
Methods inherited from class com.primavera.integration.client.bo.BusinessObject |
---|
equals, hashCode, isNull, setNull |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public RiskMatrix(Session session)
session
- the Sessionpublic RiskMatrix(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic RiskMatrix(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
session
- the SessionrowSet
- the PrmRowSet retrieved from the serveriIndex
- the row index in the PrmRowSet associated with this business object
BusinessObjectException
- if a problem occurred in the client-side business objectsMethod Detail |
---|
public ObjectId createRiskMatrixScore(RiskMatrixScore riskmatrixscore) throws ServerException, NetworkException, BusinessObjectException
riskmatrixscore
- RiskMatrixScore object to create
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId[] createRiskMatrixScores(RiskMatrixScore[] riskmatrixscores) throws ServerException, NetworkException, BusinessObjectException
riskmatrixscores
- array of RiskMatrixScore objects to create
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic BOIterator<RiskMatrixScore> loadRiskMatrixScores(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void updateRiskMatrixScores(RiskMatrixScore[] riskmatrixscores) throws ServerException, NetworkException, BusinessObjectException
riskmatrixscores
- array of RiskMatrixScore objects to update
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void deleteRiskMatrixScores(RiskMatrixScore[] riskmatrixscores) throws ServerException, NetworkException, BusinessObjectException
riskmatrixscores
- array of RiskMatrixScore objects to delete
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId createRiskMatrixThreshold(RiskMatrixThreshold riskmatrixthreshold) throws ServerException, NetworkException, BusinessObjectException
riskmatrixthreshold
- RiskMatrixThreshold object to create
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId[] createRiskMatrixThresholds(RiskMatrixThreshold[] riskmatrixthresholds) throws ServerException, NetworkException, BusinessObjectException
riskmatrixthresholds
- array of RiskMatrixThreshold objects to create
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic BOIterator<RiskMatrixThreshold> loadRiskMatrixThresholds(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void deleteRiskMatrixThresholds(RiskMatrixThreshold[] riskmatrixthresholds) throws ServerException, NetworkException, BusinessObjectException
riskmatrixthresholds
- array of RiskMatrixThreshold objects to delete
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic BOIterator<Project> loadProjects(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setObjectId(ObjectId o) throws BusinessObjectException
setObjectId
in class BusinessObject
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setName(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getDescription() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDescription(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic RiskScoreMatrixMethod getRiskScoringMethod() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setRiskScoringMethod(RiskScoreMatrixMethod enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Date getCreateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Date getLastUpdateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getCreateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getLastUpdateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getImpactThresholdLevel() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getProbabilityThresholdLevel() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static String[] getRequiredCreateFields()
public static String[] getFilterableFields()
public static String[] getInternalDefaultLoadFields()
public static String[] getAllFields()
public static String[] getInternalAllFields()
public static Set<String> getInternalAllFieldsSet()
public static String[] getWritableFields()
@Deprecated public static String[] getDefaultXMLExportFields()
public static String[] getMinimumXMLExportFields()
public String toString()
toString
in class Object
public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static ObjectId[] create(Session session, RiskMatrix[] riskmatrices) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectriskmatrices
- array of RiskMatrix objects to create
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static RiskMatrix load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the RiskMatrix object
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static BOIterator<RiskMatrix> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the RiskMatrix objects
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void update() throws ServerException, NetworkException, BusinessObjectException
update
in class com.primavera.integration.client.BOBase
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static void update(Session session, RiskMatrix[] riskmatrices) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectriskmatrices
- array of RiskMatrix objects to update
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void delete() throws ServerException, NetworkException, BusinessObjectException
delete
in class com.primavera.integration.client.BOBase
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static void delete(Session session, RiskMatrix[] riskmatrices) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectriskmatrices
- array of RiskMatrix objects to delete
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objects
|
Primavera Integration API Release 8 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |