|
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.ActivityRisk
public class ActivityRisk
The activity risk object stores the relationship between a single Activity and a single Risk.
Note that this business object has a multi-part object ID; its object ID is a combination of its activity object ID and its risk object ID. The method createObjectId() can be used to create the multi-part object ID from the individual IDs.
See Also: Quick reference of ActivityRisk fields
Constructor Summary | |
---|---|
ActivityRisk(Session session)
Class constructor specifying the Session. |
|
ActivityRisk(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
ActivityRisk(Session session,
ObjectId riskObjectId,
ObjectId activityObjectId)
Class constructor specifying the Session and the individual components of the multi-part key: RiskObjectId and ActivityObjectId. |
|
ActivityRisk(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 ActivityRisk object in the database. |
static ObjectId[] |
create(Session session,
ActivityRisk[] activityrisks)
Creates multiple ActivityRisk objects in the database. |
static ObjectId |
createObjectId(ObjectId riskObjectId,
ObjectId activityObjectId)
Creates a multi-part ObjectId from two individual ObjectIds. |
void |
delete()
Deletes this ActivityRisk object from the database. |
static void |
delete(Session session,
ActivityRisk[] activityrisks)
Deletes multiple ActivityRisk objects from the database. |
String |
getActivityId()
Gets the id of an activity impacted by the Risk. |
String |
getActivityName()
Gets the name of an activity impacted by the Risk. |
ObjectId |
getActivityObjectId()
Gets the unique ID of the activity to which the risk is assigned. |
static String[] |
getAllFields()
Gets all fields for this business object. |
Date |
getCreateDate()
Gets the date this activity was created. |
String |
getCreateUser()
Gets the name of the user that created this activity risk. |
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 activity was last updated. |
String |
getLastUpdateUser()
Gets the name of the user that last updated this activity risk. |
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 code 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. |
static String[] |
getWritableFields()
Gets all writable fields for this business object. |
static ActivityRisk |
load(Session session,
String[] fields,
ObjectId objId)
Loads a single ActivityRisk object from the database. |
static BOIterator<ActivityRisk> |
load(Session session,
String[] fields,
ObjectId[] objIds)
Loads multiple ActivityRisk objects from the database. |
Activity |
loadActivity(String[] fields)
Loads an associated Activity object 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. |
void |
setActivityObjectId(ObjectId o)
Sets the unique ID of the activity to which the risk is assigned. |
void |
setRiskObjectId(ObjectId o)
Sets the unique ID of the associated risk. |
String |
toString()
Returns a string representation of the object. |
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 ActivityRisk(Session session)
session
- the Sessionpublic ActivityRisk(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ActivityRisk(Session session, ObjectId riskObjectId, ObjectId activityObjectId) throws BusinessObjectException
session
- the SessionriskObjectId
- the first ObjectId in the keyactivityObjectId
- the second ObjectId in the key
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ActivityRisk(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 Activity loadActivity(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 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 ObjectId getProjectObjectId() 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 String getProjectId() throws BusinessObjectException
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 getActivityObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setActivityObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getActivityId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getActivityName() 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 activityObjectId) throws InvalidValueException
riskObjectId
- the ObjectId of the associated risk object.activityObjectId
- the ObjectId of the associated activity 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, ActivityRisk[] activityrisks) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectactivityrisks
- array of ActivityRisk 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 ActivityRisk load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ActivityRisk 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<ActivityRisk> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ActivityRisk 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 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, ActivityRisk[] activityrisks) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectactivityrisks
- array of ActivityRisk 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 |