|
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.RiskImpact
public class RiskImpact
The risk impact object stores the pre-response qualitative value assigned to a risk for each of the risk thresholds.
Note that this business object has a multi-part object ID; its object ID is a combination of its risk object ID and its risk threshold object ID. The risk threshold object ID is set based on the value used in risk threshold level object ID. The method createObjectId() can be used to create the multi-part object ID from the individual IDs.
See Also: Quick reference of RiskImpact fields
Constructor Summary | |
---|---|
RiskImpact(Session session)
Class constructor specifying the Session. |
|
RiskImpact(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
RiskImpact(Session session,
ObjectId riskObjectId,
ObjectId riskThresholdObjectId)
Class constructor specifying the Session and the individual components of the multi-part key: RiskObjectId and RiskThresholdObjectId. |
|
RiskImpact(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 RiskImpact object in the database. |
static ObjectId[] |
create(Session session,
RiskImpact[] riskimpacts)
Creates multiple RiskImpact objects in the database. |
static ObjectId |
createObjectId(ObjectId riskObjectId,
ObjectId riskThresholdObjectId)
Creates a multi-part ObjectId from two individual ObjectIds. |
void |
delete()
Deletes this RiskImpact object from the database. |
static void |
delete(Session session,
RiskImpact[] riskimpacts)
Deletes multiple RiskImpact objects from the database. |
static String[] |
getAllFields()
Gets all fields for this business object. |
Date |
getCreateDate()
Gets the date this risk impact was created. |
String |
getCreateUser()
Gets the name of the user that created the risk impact. |
static String[] |
getDefaultXMLExportFields()
Deprecated. |
static String[] |
getFilterableFields()
Gets all fields that can be filtered. |
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. |
boolean |
getIsBaseline()
Gets the boolean value indicating if this business object is related to a Project or Baseline. |
boolean |
getIsTemplate()
Gets the boolean value indicating if this business object is related to a template Project. |
Date |
getLastUpdateDate()
Gets the date this risk impact was last updated. |
String |
getLastUpdateUser()
Gets the name of the user that last updated the risk impact. |
static String[] |
getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter |
ObjectId |
getObjectId()
Gets the ObjectId for this object. |
String |
getProjectId()
Gets the short name of the associated project. |
String |
getProjectName()
Gets the name of the associated project. |
ObjectId |
getProjectObjectId()
Gets the unique ID of the associated project. |
static String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
String |
getRiskId()
Gets the ID of the Risk. |
String |
getRiskName()
Gets the name of the Risk. |
ObjectId |
getRiskObjectId()
Gets the unique ID of the associated risk. |
String |
getRiskThresholdLevelCode()
Gets the 10 character short name for the threshold level. |
String |
getRiskThresholdLevelName()
Gets the 40 character name for the threshold level. |
ObjectId |
getRiskThresholdLevelObjectId()
Gets the unique ID of the associated Risk Threshold. |
String |
getRiskThresholdName()
Gets the name of the associated risk score type. |
ObjectId |
getRiskThresholdObjectId()
Gets the unique ID of the associated Risk Threshold Type. |
static String[] |
getWritableFields()
Gets all writable fields for this business object. |
static RiskImpact |
load(Session session,
String[] fields,
ObjectId objId)
Loads a single RiskImpact object from the database. |
static BOIterator<RiskImpact> |
load(Session session,
String[] fields,
ObjectId[] objIds)
Loads multiple RiskImpact objects from the database. |
Project |
loadProject(String[] fields)
Loads an associated Project object from the database. |
Risk |
loadRisk(String[] fields)
Loads an associated Risk object from the database. |
RiskThreshold |
loadRiskThreshold(String[] fields)
Loads an associated RiskThreshold object from the database. |
RiskThresholdLevel |
loadRiskThresholdLevel(String[] fields)
Loads an associated RiskThresholdLevel object from the database. |
void |
setRiskObjectId(ObjectId o)
Sets the unique ID of the associated risk. |
void |
setRiskThresholdLevelObjectId(ObjectId o)
Sets the unique ID of the associated Risk Threshold. |
String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this RiskImpact object in the database. |
static void |
update(Session session,
RiskImpact[] riskimpacts)
Updates multiple RiskImpact objects in the database. |
Methods inherited from class com.primavera.integration.client.bo.BusinessObject |
---|
equals, hashCode, isNull, setNull, setObjectId |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public RiskImpact(Session session)
session
- the Sessionpublic RiskImpact(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic RiskImpact(Session session, ObjectId riskObjectId, ObjectId riskThresholdObjectId) throws BusinessObjectException
session
- the SessionriskObjectId
- the first ObjectId in the keyriskThresholdObjectId
- the second ObjectId in the key
BusinessObjectException
- if a problem occurred in the client-side business objectspublic RiskImpact(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 Risk loadRisk(String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 Project loadProject(String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 RiskThreshold loadRiskThreshold(String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 RiskThresholdLevel loadRiskThresholdLevel(String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 getRiskObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setRiskObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getRiskId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getRiskName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getProjectObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getProjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getProjectName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getRiskThresholdObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getRiskThresholdName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getRiskThresholdLevelObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setRiskThresholdLevelObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getRiskThresholdLevelCode() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getRiskThresholdLevelName() throws BusinessObjectException
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 boolean getIsBaseline() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsTemplate() 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 static ObjectId createObjectId(ObjectId riskObjectId, ObjectId riskThresholdObjectId) throws InvalidValueException
riskObjectId
- the ObjectId of the associated risk object.riskThresholdObjectId
- the ObjectId of the associated riskThreshold object.
InvalidValueException
- if one of the input parameters was invalid.
IllegalArgumentException
- if one of the input parameters was null.public ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if the ObjectId fields were not loaded.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, RiskImpact[] riskimpacts) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectriskimpacts
- array of RiskImpact 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 RiskImpact load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the RiskImpact 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<RiskImpact> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the RiskImpact 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, RiskImpact[] riskimpacts) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectriskimpacts
- array of RiskImpact 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, RiskImpact[] riskimpacts) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectriskimpacts
- array of RiskImpact 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 |