|
Primavera Integration API 7.0 | |||||||||
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.ActivityCodeAssignment
public class ActivityCodeAssignment
An activity code assignment business object represents the assignment of an activity code to an activity. For each activity code type, an activity may have zero or one activity codes assigned.
See Also: Quick reference of ActivityCodeAssignment fields
Constructor Summary | |
---|---|
ActivityCodeAssignment(Session session)
Class constructor specifying the Session. |
|
ActivityCodeAssignment(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
ActivityCodeAssignment(Session session,
ObjectId activityObjectId,
ObjectId activityCodeTypeObjectId)
Class constructor specifying the Session and the individual components of the multi-part key: ActivityObjectId and ActivityCodeTypeObjectId. |
|
ActivityCodeAssignment(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 ActivityCodeAssignment object in the database. |
static ObjectId[] |
create(Session session,
ActivityCodeAssignment[] activitycodeassignments)
Creates multiple ActivityCodeAssignment objects in the database. |
static ObjectId |
createObjectId(ObjectId activityObjectId,
ObjectId activityCodeTypeObjectId)
Creates a multi-part ObjectId from two individual ObjectIds. |
void |
delete()
Deletes this ActivityCodeAssignment object from the database. |
static void |
delete(Session session,
ActivityCodeAssignment[] activitycodeassignments)
Deletes multiple ActivityCodeAssignment objects from the database. |
java.lang.String |
getActivityCodeDescription()
Gets the description of the associated activity code. |
ObjectId |
getActivityCodeObjectId()
Gets the unique ID of the associated activity code. |
java.lang.String |
getActivityCodeTypeName()
Gets the name of the parent activity code type. |
ObjectId |
getActivityCodeTypeObjectId()
Gets the unique ID of the parent activity code type. |
ActivityCodeTypeScope |
getActivityCodeTypeScope()
Gets the scope of the associated activity code type: Global, EPS, or Project. |
java.lang.String |
getActivityCodeValue()
Gets the value of the associated activity code. |
java.lang.String |
getActivityId()
Gets the short ID that uniquely identifies the activity to which the activity code is assigned. |
java.lang.String |
getActivityName()
Gets the name of the activity to which the activity code is assigned. |
ObjectId |
getActivityObjectId()
Gets the unique ID of the activity to which the activity code is assigned. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
java.util.Date |
getCreateDate()
Gets the date this code assignment was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this code assignment. |
static java.lang.String[] |
getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified. |
static java.lang.String[] |
getFilterableFields()
Gets all fields that can be filtered. |
static java.lang.String[] |
getInternalAllFields()
An internal method that should not be called directly by client code. |
static java.util.Set<java.lang.String> |
getInternalAllFieldsSet()
An internal method that should not be called directly by client code. |
static java.lang.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. |
java.util.Date |
getLastUpdateDate()
Gets the date this code assignment was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this code assignment. |
static java.lang.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. |
java.lang.String |
getProjectId()
Gets the short code of the associated project. |
ObjectId |
getProjectObjectId()
Gets the unique ID of the associated project. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
ObjectId |
getWBSObjectId()
Gets the unique ID of the WBS for the associated activity. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static ActivityCodeAssignment |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single ActivityCodeAssignment object from the database. |
static BOIterator<ActivityCodeAssignment> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple ActivityCodeAssignment objects from the database. |
Activity |
loadActivity(java.lang.String[] fields)
Loads an associated Activity object from the database. |
ActivityCode |
loadActivityCode(java.lang.String[] fields)
Loads an associated ActivityCode object from the database. |
ActivityCodeType |
loadActivityCodeType(java.lang.String[] fields)
Loads an associated ActivityCodeType object from the database. |
Project |
loadProject(java.lang.String[] fields)
Loads an associated Project object from the database. |
void |
setActivityCodeObjectId(ObjectId o)
Sets the unique ID of the associated activity code. |
void |
setActivityObjectId(ObjectId o)
Sets the unique ID of the activity to which the activity code is assigned. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this ActivityCodeAssignment object in the database. |
static void |
update(Session session,
ActivityCodeAssignment[] activitycodeassignments)
Updates multiple ActivityCodeAssignment 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 ActivityCodeAssignment(Session session)
session
- the Sessionpublic ActivityCodeAssignment(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ActivityCodeAssignment(Session session, ObjectId activityObjectId, ObjectId activityCodeTypeObjectId) throws BusinessObjectException
session
- the SessionactivityObjectId
- the first ObjectId in the keyactivityCodeTypeObjectId
- the second ObjectId in the key
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ActivityCodeAssignment(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 static ObjectId createObjectId(ObjectId activityObjectId, ObjectId activityCodeTypeObjectId) throws InvalidValueException
activityObjectId
- the ObjectId of the associated activity object.activityCodeTypeObjectId
- the ObjectId of the associated activityCodeType object.
InvalidValueException
- if one of the input parameters was invalid.
java.lang.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, ActivityCodeAssignment[] activitycodeassignments) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectactivitycodeassignments
- array of ActivityCodeAssignment 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 ActivityCodeAssignment load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ActivityCodeAssignment 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<ActivityCodeAssignment> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ActivityCodeAssignment 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 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, ActivityCodeAssignment[] activitycodeassignments) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectactivitycodeassignments
- array of ActivityCodeAssignment 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 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, ActivityCodeAssignment[] activitycodeassignments) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectactivitycodeassignments
- array of ActivityCodeAssignment 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 ActivityCodeType loadActivityCodeType(java.lang.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 ActivityCode loadActivityCode(java.lang.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 Activity loadActivity(java.lang.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(java.lang.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 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 java.lang.String getActivityId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getWBSObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getActivityName() 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 java.lang.String getProjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getActivityCodeTypeObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getActivityCodeObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setActivityCodeObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getActivityCodeTypeName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getActivityCodeDescription() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getActivityCodeValue() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ActivityCodeTypeScope getActivityCodeTypeScope() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getCreateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getLastUpdateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getCreateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.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 static java.lang.String[] getRequiredCreateFields()
public static java.lang.String[] getFilterableFields()
public static java.lang.String[] getInternalDefaultLoadFields()
public static java.lang.String[] getAllFields()
public static java.lang.String[] getInternalAllFields()
public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
public static java.lang.String[] getWritableFields()
public static java.lang.String[] getDefaultXMLExportFields()
public static java.lang.String[] getMinimumXMLExportFields()
public java.lang.String toString()
toString
in class java.lang.Object
|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |