|
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.Role
public class Role
Roles are project personnel job titles or skills, such as mechanical engineer, inspector, or carpenter. They represent a type of resource with a certain level of proficiency rather than a specific individual. Roles can also be assigned to specific resources to further identify that resource's skills. For example, a resource may have a role of a engineer and manager.
You can create a set of roles to assign to resources and activities in all projects in the enterprise. You can establish an unlimited number of roles and organize them in a hierarchy for easier management and assignment. The set of roles you assign to an activity defines the activity's skill requirements.
You can temporarily assign roles during the planning stages of the project to see how certain resources affect the schedule. Once you finalize your plans, you can replace the roles with resources that fulfill the role skill levels. Five proficiency levels can be assigned to roles: Master, Expert, Skilled, Proficient and Inexperienced.
Roles may be loaded with summarized project role spreads using the loadWithProjectRoleSpread() method. All projects must have been previously summarized using the summarizer job service. The ObjectId(s) of the project(s) are normally specified for which to load the project role spreads. If no project ObjectIds are specified, project role spreads are loaded for all projects to which the role is assigned. After loading, call the getProjectRoleSpreads() method to access the spread data.
Roles are hierarchical objects.
See Also: Quick reference of Role fields
Constructor Summary | |
---|---|
Role(Session session)
Class constructor specifying the Session. |
|
Role(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
Role(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 Role object in the database. |
static ObjectId[] |
create(Session session,
Role[] roles)
Creates multiple Role objects in the database. |
ObjectId |
createRoleChild(Role rolechild)
Creates an associated Role object in the database. |
ObjectId[] |
createRoleChildren(Role[] rolechildren)
Creates multiple associated Role objects in the database. |
ObjectId |
createRoleLimit(RoleLimit rolelimit)
Creates an associated RoleLimit object in the database. |
ObjectId[] |
createRoleLimits(RoleLimit[] rolelimits)
Creates multiple associated RoleLimit objects in the database. |
ObjectId |
createRoleRate(RoleRate rolerate)
Creates an associated RoleRate object in the database. |
void |
delete()
Deletes this Role object from the database. |
void |
delete(ObjectId replacementId)
Deletes this Role object from the database. |
static void |
delete(Session session,
Role[] roles)
Deletes multiple Role objects from the database. |
static void |
delete(Session session,
Role[] roles,
ObjectId replacementParent)
Deletes multiple role objects in a hierarchy from the database and set the new parent of all child objects. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
boolean |
getCalculateCostFromUnits()
Gets the option that indicates whether costs and quantities are linked, and whether quantities should be updated when costs are updated. |
java.util.Date |
getCreateDate()
Gets the date this role was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this 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. |
java.lang.String |
getId()
Gets the short code that uniquely identifies the role. |
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 role was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this role. |
static java.lang.String[] |
getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter |
java.lang.String |
getName()
Gets the name of the role. |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
ObjectId |
getParentObjectId()
Gets the unique ID of the parent role of this role in the hierarchy. |
ProjectRoleSpread[] |
getProjectRoleSpreads()
Gets the field containing project spread data for this role. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
java.lang.String |
getResponsibilities()
Gets the responsibilities for the role. |
static java.lang.String[] |
getRoleSpreadFields()
Gets all spread fields that can be specified in the spreadFields parameter of loadWithProjectRoleSpread methods for this business object. |
int |
getSequenceNumber()
Gets the sequence number for sorting. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static Role |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single Role object from the database. |
static BOIterator<Role> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple Role objects from the database. |
Role |
loadParentRole(java.lang.String[] fields)
Loads an associated Role object from the database. |
BOIterator<ResourceAssignment> |
loadResourceAssignments(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated ResourceAssignment objects from the database. |
BOIterator<ResourceRole> |
loadResourceRoles(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated ResourceRole objects from the database. |
BOIterator<Role> |
loadRoleChildren(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated Role objects from the database. |
BOIterator<RoleLimit> |
loadRoleLimits(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated RoleLimit objects from the database. |
RoleRate |
loadRoleRate(java.lang.String[] fields)
Loads an associated RoleRate object from the database. |
static BOIterator<Role> |
loadRootRoles(Session session,
java.lang.String[] fields)
Loads the root Role objects from the database. |
static BOIterator<Role> |
loadWithProjectRoleSpread(Session session,
java.lang.String[] nonSpreadFields,
ObjectId[] objIds,
java.lang.String[] spreadFields,
SpreadPeriodType periodType,
java.util.Date startDate,
java.util.Date endDate,
boolean bIncludeCumulative,
ObjectId[] projectObjectIds)
Loads multiple Role objects with Role spreads from the database. |
static Role |
loadWithProjectRoleSpread(Session session,
java.lang.String[] nonSpreadFields,
ObjectId objId,
java.lang.String[] spreadFields,
SpreadPeriodType periodType,
java.util.Date startDate,
java.util.Date endDate,
boolean bIncludeCumulative,
ObjectId[] projectObjectIds)
Loads a Role object with Role spreads from the database. |
void |
setCalculateCostFromUnits(boolean b)
Sets the option that indicates whether costs and quantities are linked, and whether quantities should be updated when costs are updated. |
void |
setId(java.lang.String s)
Sets the short code that uniquely identifies the role. |
void |
setName(java.lang.String s)
Sets the name of the role. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setParentObjectId(ObjectId o)
Sets the unique ID of the parent role of this role in the hierarchy. |
void |
setResponsibilities(java.lang.String s)
Sets the responsibilities for the role. |
void |
setSequenceNumber(int i)
Sets the sequence number for sorting. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this Role object in the database. |
static void |
update(Session session,
Role[] roles)
Updates multiple Role objects in the database. |
Methods inherited from class com.primavera.integration.client.bo.BusinessObject |
---|
equals, hashCode, isNull, setNull |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Role(Session session)
session
- the Sessionpublic Role(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Role(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 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, Role[] roles) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectroles
- array of Role 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 Role load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the Role 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 Role loadWithProjectRoleSpread(Session session, java.lang.String[] nonSpreadFields, ObjectId objId, java.lang.String[] spreadFields, SpreadPeriodType periodType, java.util.Date startDate, java.util.Date endDate, boolean bIncludeCumulative, ObjectId[] projectObjectIds) throws ServerException, NetworkException, BusinessObjectException
nonSpreadFields
- fields to loadobjId
- unique ID of the Role objectspreadFields
- the fields to include in the spread objectperiodType
- the period of the spread data (hour, day, etc.)startDate
- the start date of the spreadendDate
- the end date of the spreadbIncludeCumulative
- indicates whether to include cumulative spread dataprojectObjectIds
- indicates
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<Role> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the Role 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 static BOIterator<Role> loadWithProjectRoleSpread(Session session, java.lang.String[] nonSpreadFields, ObjectId[] objIds, java.lang.String[] spreadFields, SpreadPeriodType periodType, java.util.Date startDate, java.util.Date endDate, boolean bIncludeCumulative, ObjectId[] projectObjectIds) throws ServerException, NetworkException, BusinessObjectException
nonSpreadFields
- fields to loadobjIds
- object ids of the Role objectsspreadFields
- the fields to include in the spread objectperiodType
- the period of the spread data (hour, day, etc.)startDate
- the start date of the spreadendDate
- the end date of the spreadbIncludeCumulative
- indicates whether to include cumulative spread data
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, Role[] roles) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectroles
- array of Role 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 void delete(ObjectId replacementId) throws ServerException, NetworkException, BusinessObjectException
delete
in class BOBase
replacementId
- unique ID of the new parent for all current child 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 static void delete(Session session, Role[] roles) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectroles
- array of Role 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 static void delete(Session session, Role[] roles, ObjectId replacementParent) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectroles
- array of Role objects to deletereplacementParent
- replacement parent 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 Role loadParentRole(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 createRoleChild(Role rolechild) throws ServerException, NetworkException, BusinessObjectException
rolechild
- RoleChild object 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 ObjectId[] createRoleChildren(Role[] rolechildren) throws ServerException, NetworkException, BusinessObjectException
rolechildren
- array of RoleChild 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 BOIterator<Role> loadRoleChildren(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
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<Role> loadRootRoles(Session session, java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- 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 BOIterator<ResourceRole> loadResourceRoles(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
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 BOIterator<ResourceAssignment> loadResourceAssignments(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
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 createRoleRate(RoleRate rolerate) throws ServerException, NetworkException, BusinessObjectException
rolerate
- RoleRate object 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 RoleRate loadRoleRate(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 createRoleLimit(RoleLimit rolelimit) throws ServerException, NetworkException, BusinessObjectException
rolelimit
- RoleLimit object 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 ObjectId[] createRoleLimits(RoleLimit[] rolelimits) throws ServerException, NetworkException, BusinessObjectException
rolelimits
- array of RoleLimit 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 BOIterator<RoleLimit> loadRoleLimits(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
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 getParentObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setParentObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setObjectId(ObjectId o) throws BusinessObjectException
setObjectId
in class BusinessObject
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getSequenceNumber() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setSequenceNumber(int i) throws BusinessObjectException
i
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setId(java.lang.String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setName(java.lang.String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getResponsibilities() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setResponsibilities(java.lang.String s) throws BusinessObjectException
s
- the value to set this field to
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 getCalculateCostFromUnits() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setCalculateCostFromUnits(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ProjectRoleSpread[] getProjectRoleSpreads() 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[] getRoleSpreadFields()
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 |