|
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.ActivityOwner
public class ActivityOwner
Activity owner objects provide a way to specify a user to be in charge of an activity for statusing in Primavera Web Access. Instead of assigning resources to activities, a user is able to assign a specific user to the activity. The activity owner, in conjunction with a Team Member license, gives users similar capabilities as a resource and Team Member license.
Note that this business object has a multi-part object ID; its object ID is a combination of its activity object ID and its user object ID. The method createObjectId() can be used to create the multi-part object ID from the individual IDs.
This is a read-only business object.
See Also: Quick reference of ActivityOwner fields
Constructor Summary | |
---|---|
ActivityOwner(Session session)
Class constructor specifying the Session. |
|
ActivityOwner(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
ActivityOwner(Session session,
ObjectId activityObjectId,
ObjectId userObjectId)
Class constructor specifying the Session and the individual components of the multi-part key: ActivityObjectId and UserObjectId. |
|
ActivityOwner(Session session,
com.primavera.infr.db.PrmRowSet rowSet,
int iIndex)
Class constructor called internally after objects are retrieved from the server. |
Method Summary | |
---|---|
static ObjectId |
createObjectId(ObjectId activityObjectId,
ObjectId userObjectId)
Creates a multi-part ObjectId from two individual ObjectIds. |
ObjectId |
getActivityObjectId()
Gets the unique ID of the associated activity. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
java.util.Date |
getCreateDate()
Gets the date this activity owner was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this activity owner. |
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 activity owner was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this activity owner. |
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. |
ObjectId |
getProjectObjectId()
Gets the unique ID of the associated project. |
ObjectId |
getUserObjectId()
Gets the unique ID of the associated user. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static ActivityOwner |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single ActivityOwner object from the database. |
static BOIterator<ActivityOwner> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple ActivityOwner objects from the database. |
Activity |
loadActivity(java.lang.String[] fields)
Loads an associated Activity object from the database. |
Project |
loadProject(java.lang.String[] fields)
Loads an associated Project object from the database. |
User |
loadUser(java.lang.String[] fields)
Loads an associated User object from the database. |
java.lang.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 ActivityOwner(Session session)
session
- the Sessionpublic ActivityOwner(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ActivityOwner(Session session, ObjectId activityObjectId, ObjectId userObjectId) throws BusinessObjectException
session
- the SessionactivityObjectId
- the first ObjectId in the keyuserObjectId
- the second ObjectId in the key
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ActivityOwner(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 userObjectId) throws InvalidValueException
activityObjectId
- the ObjectId of the associated activity object.userObjectId
- the ObjectId of the associated user 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 static ActivityOwner load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ActivityOwner 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<ActivityOwner> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ActivityOwner 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 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 User loadUser(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 ObjectId getUserObjectId() 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.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[] 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 |