|
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.ResourceRole
public class ResourceRole
A resource role object represents an association between a resource object and a role object. A proficiency may be assigned to a resource role.
Note that this business object has a multi-part object ID; its object ID is a combination of its resource object ID and its role object ID. The method createObjectId() can be used to create the multi-part object ID from the individual IDs.
See Also: Quick reference of ResourceRole fields
Constructor Summary | |
---|---|
ResourceRole(Session session)
Class constructor specifying the Session. |
|
ResourceRole(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
ResourceRole(Session session,
ObjectId resourceObjectId,
ObjectId roleObjectId)
Class constructor specifying the Session and the individual components of the multi-part key: ResourceObjectId and RoleObjectId. |
|
ResourceRole(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 ResourceRole object in the database. |
static ObjectId[] |
create(Session session,
ResourceRole[] resourceroles)
Creates multiple ResourceRole objects in the database. |
static ObjectId |
createObjectId(ObjectId resourceObjectId,
ObjectId roleObjectId)
Creates a multi-part ObjectId from two individual ObjectIds. |
void |
delete()
Deletes this ResourceRole object from the database. |
static void |
delete(Session session,
ResourceRole[] resourceroles)
Deletes multiple ResourceRole objects from the database. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
java.util.Date |
getCreateDate()
Gets the date this resource role was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this resource role. |
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. |
java.util.Date |
getLastUpdateDate()
Gets the date this resource role was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this resource role. |
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. |
Proficiency |
getProficiency()
Gets the resource's proficiency at performing this role. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
java.lang.String |
getResourceId()
Gets the short code that uniquely identifies the resource. |
java.lang.String |
getResourceName()
Gets the name of the resource. |
ObjectId |
getResourceObjectId()
Gets the unique ID of the associated resource. |
java.lang.String |
getRoleId()
Gets the short code that uniquely identifies the role. |
java.lang.String |
getRoleName()
Gets the name of the role. |
ObjectId |
getRoleObjectId()
Gets the unique ID of the associated role. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static ResourceRole |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single ResourceRole object from the database. |
static BOIterator<ResourceRole> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple ResourceRole objects from the database. |
Resource |
loadResource(java.lang.String[] fields)
Loads an associated Resource object from the database. |
Role |
loadRole(java.lang.String[] fields)
Loads an associated Role object from the database. |
void |
setProficiency(Proficiency enm)
Sets the resource's proficiency at performing this role. |
void |
setResourceObjectId(ObjectId o)
Sets the unique ID of the associated resource. |
void |
setRoleObjectId(ObjectId o)
Sets the unique ID of the associated role. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this ResourceRole object in the database. |
static void |
update(Session session,
ResourceRole[] resourceroles)
Updates multiple ResourceRole 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 ResourceRole(Session session)
session
- the Sessionpublic ResourceRole(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ResourceRole(Session session, ObjectId resourceObjectId, ObjectId roleObjectId) throws BusinessObjectException
session
- the SessionresourceObjectId
- the first ObjectId in the keyroleObjectId
- the second ObjectId in the key
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ResourceRole(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 resourceObjectId, ObjectId roleObjectId) throws InvalidValueException
resourceObjectId
- the ObjectId of the associated resource object.roleObjectId
- the ObjectId of the associated role 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, ResourceRole[] resourceroles) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectresourceroles
- array of ResourceRole 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 ResourceRole load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ResourceRole 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<ResourceRole> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ResourceRole 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, ResourceRole[] resourceroles) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectresourceroles
- array of ResourceRole 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, ResourceRole[] resourceroles) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectresourceroles
- array of ResourceRole 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 Resource loadResource(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 Role loadRole(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 getResourceObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setResourceObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getRoleObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setRoleObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Proficiency getProficiency() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setProficiency(Proficiency enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getResourceId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getResourceName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getRoleId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getRoleName() 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 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 |