Primavera Integration API 7.0

com.primavera.integration.client.bo.object
Class Role

java.lang.Object
  extended by com.primavera.integration.client.BOBase
      extended by com.primavera.integration.client.bo.BusinessObject
          extended by com.primavera.integration.client.bo.object.Role

public class Role
extends BusinessObject

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

Role

public Role(Session session)
Class constructor specifying the Session. This constructor is most commonly used when create() is intended to be called on this object.

Parameters:
session - the Session

Role

public Role(Session session,
            ObjectId objId)
     throws BusinessObjectException
Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() will be called on this object.

Parameters:
session - the Session
objId - the ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

Role

public Role(Session session,
            com.primavera.infr.db.PrmRowSet rowSet,
            int iIndex)
     throws BusinessObjectException
Class constructor called internally after objects are retrieved from the server. Client code should use one of the other constructors for this class.

Parameters:
session - the Session
rowSet - the PrmRowSet retrieved from the server
iIndex - the row index in the PrmRowSet associated with this business object
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects
Method Detail

create

public ObjectId create()
                throws ServerException,
                       NetworkException,
                       BusinessObjectException
Creates this Role object in the database.

Returns:
ObjectId the unique ID of the newly created Role object
Throws:
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

create

public static ObjectId[] create(Session session,
                                Role[] roles)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple Role objects in the database.

Parameters:
session - the Session object
roles - array of Role objects to create
Returns:
ObjectId[] the array of unique IDs of newly created Role objects
Throws:
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

load

public static Role load(Session session,
                        java.lang.String[] fields,
                        ObjectId objId)
                 throws ServerException,
                        NetworkException,
                        BusinessObjectException
Loads a single Role object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the Role object
Returns:
Role the Role object
Throws:
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

loadWithProjectRoleSpread

public 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
Loads a Role object with Role spreads from the database.

Parameters:
nonSpreadFields - fields to load
objId - unique ID of the Role object
spreadFields - the fields to include in the spread object
periodType - the period of the spread data (hour, day, etc.)
startDate - the start date of the spread
endDate - the end date of the spread
bIncludeCumulative - indicates whether to include cumulative spread data
projectObjectIds - indicates
Returns:
Role the Role object
Throws:
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

load

public static BOIterator<Role> load(Session session,
                                    java.lang.String[] fields,
                                    ObjectId[] objIds)
                             throws ServerException,
                                    NetworkException,
                                    BusinessObjectException
Loads multiple Role objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the Role objects
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
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

loadWithProjectRoleSpread

public 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
Loads multiple Role objects with Role spreads from the database.

Parameters:
nonSpreadFields - fields to load
objIds - object ids of the Role objects
spreadFields - the fields to include in the spread object
periodType - the period of the spread data (hour, day, etc.)
startDate - the start date of the spread
endDate - the end date of the spread
bIncludeCumulative - indicates whether to include cumulative spread data
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
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

update

public void update()
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Updates this Role object in the database.

Overrides:
update in class BOBase
Throws:
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

update

public static void update(Session session,
                          Role[] roles)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple Role objects in the database.

Parameters:
session - the Session object
roles - array of Role objects to update
Throws:
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

delete

public void delete()
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Deletes this Role object from the database.

Overrides:
delete in class BOBase
Throws:
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

delete

public void delete(ObjectId replacementId)
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Deletes this Role object from the database.

Overrides:
delete in class BOBase
Parameters:
replacementId - unique ID of the new parent for all current child objects
Throws:
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

delete

public static void delete(Session session,
                          Role[] roles)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple Role objects from the database.

Parameters:
session - the Session object
roles - array of Role objects to delete
Throws:
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

delete

public static void delete(Session session,
                          Role[] roles,
                          ObjectId replacementParent)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple role objects in a hierarchy from the database and set the new parent of all child objects.

Parameters:
session - the Session object
roles - array of Role objects to delete
replacementParent - replacement parent object
Throws:
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

loadParentRole

public Role loadParentRole(java.lang.String[] fields)
                    throws ServerException,
                           NetworkException,
                           BusinessObjectException
Loads an associated Role object from the database.

Parameters:
fields - fields to load
Returns:
Role the Role object
Throws:
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

createRoleChild

public ObjectId createRoleChild(Role rolechild)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates an associated Role object in the database.

Parameters:
rolechild - RoleChild object to create
Returns:
ObjectId unique ID of the newly created Role object
Throws:
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

createRoleChildren

public ObjectId[] createRoleChildren(Role[] rolechildren)
                              throws ServerException,
                                     NetworkException,
                                     BusinessObjectException
Creates multiple associated Role objects in the database.

Parameters:
rolechildren - array of RoleChild objects to create
Returns:
ObjectId[] array of object ids of newly created Role objects
Throws:
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

loadRoleChildren

public BOIterator<Role> loadRoleChildren(java.lang.String[] fields,
                                         java.lang.String sWhereClause,
                                         java.lang.String sOrderBy)
                                  throws ServerException,
                                         NetworkException,
                                         BusinessObjectException
Loads multiple associated Role objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
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

loadRootRoles

public static BOIterator<Role> loadRootRoles(Session session,
                                             java.lang.String[] fields)
                                      throws ServerException,
                                             NetworkException,
                                             BusinessObjectException
Loads the root Role objects from the database.

Parameters:
session - the Session object
fields - fields to load
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
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

loadResourceRoles

public BOIterator<ResourceRole> loadResourceRoles(java.lang.String[] fields,
                                                  java.lang.String sWhereClause,
                                                  java.lang.String sOrderBy)
                                           throws ServerException,
                                                  NetworkException,
                                                  BusinessObjectException
Loads multiple associated ResourceRole objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
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

loadResourceAssignments

public BOIterator<ResourceAssignment> loadResourceAssignments(java.lang.String[] fields,
                                                              java.lang.String sWhereClause,
                                                              java.lang.String sOrderBy)
                                                       throws ServerException,
                                                              NetworkException,
                                                              BusinessObjectException
Loads multiple associated ResourceAssignment objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
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

createRoleRate

public ObjectId createRoleRate(RoleRate rolerate)
                        throws ServerException,
                               NetworkException,
                               BusinessObjectException
Creates an associated RoleRate object in the database.

Parameters:
rolerate - RoleRate object to create
Returns:
ObjectId unique ID of newly created RoleRate object
Throws:
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

loadRoleRate

public RoleRate loadRoleRate(java.lang.String[] fields)
                      throws ServerException,
                             NetworkException,
                             BusinessObjectException
Loads an associated RoleRate object from the database.

Parameters:
fields - fields to load
Returns:
RoleRate the RoleRate object
Throws:
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

createRoleLimit

public ObjectId createRoleLimit(RoleLimit rolelimit)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates an associated RoleLimit object in the database.

Parameters:
rolelimit - RoleLimit object to create
Returns:
ObjectId unique ID of the newly created RoleLimit object
Throws:
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

createRoleLimits

public ObjectId[] createRoleLimits(RoleLimit[] rolelimits)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Creates multiple associated RoleLimit objects in the database.

Parameters:
rolelimits - array of RoleLimit objects to create
Returns:
ObjectId[] array of object ids of newly created RoleLimit objects
Throws:
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

loadRoleLimits

public BOIterator<RoleLimit> loadRoleLimits(java.lang.String[] fields,
                                            java.lang.String sWhereClause,
                                            java.lang.String sOrderBy)
                                     throws ServerException,
                                            NetworkException,
                                            BusinessObjectException
Loads multiple associated RoleLimit objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
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

getParentObjectId

public ObjectId getParentObjectId()
                           throws BusinessObjectException
Gets the unique ID of the parent role of this role in the hierarchy. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Returns:
the value in the field ParentObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setParentObjectId

public void setParentObjectId(ObjectId o)
                       throws BusinessObjectException
Sets the unique ID of the parent role of this role in the hierarchy. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the unique ID generated by the system.

Overrides:
getObjectId in class BusinessObject
Returns:
the value in the field ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setObjectId

public void setObjectId(ObjectId o)
                 throws BusinessObjectException
Sets the unique ID generated by the system.

Overrides:
setObjectId in class BusinessObject
Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getSequenceNumber

public int getSequenceNumber()
                      throws BusinessObjectException
Gets the sequence number for sorting.

Returns:
the value in the field SequenceNumber
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setSequenceNumber

public void setSequenceNumber(int i)
                       throws BusinessObjectException
Sets the sequence number for sorting.

Parameters:
i - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getId

public java.lang.String getId()
                       throws BusinessObjectException
Gets the short code that uniquely identifies the role. This field must contain a valid value in order to create this type of business object in the database.

Returns:
the value in the field Id
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setId

public void setId(java.lang.String s)
           throws BusinessObjectException
Sets the short code that uniquely identifies the role. This field must contain a valid value in order to create this type of business object in the database.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getName

public java.lang.String getName()
                         throws BusinessObjectException
Gets the name of the role. The role name uniquely identifies the role. This field must contain a valid value in order to create this type of business object in the database.

Returns:
the value in the field Name
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setName

public void setName(java.lang.String s)
             throws BusinessObjectException
Sets the name of the role. The role name uniquely identifies the role. This field must contain a valid value in order to create this type of business object in the database.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getResponsibilities

public java.lang.String getResponsibilities()
                                     throws BusinessObjectException
Gets the responsibilities for the role. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field Responsibilities
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setResponsibilities

public void setResponsibilities(java.lang.String s)
                         throws BusinessObjectException
Sets the responsibilities for the role. This field may not be included in the where clause or order by clause specified when loading business objects.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this role was created.

Returns:
the value in the field CreateDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateDate

public java.util.Date getLastUpdateDate()
                                 throws BusinessObjectException
Gets the date this role was last updated.

Returns:
the value in the field LastUpdateDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateUser

public java.lang.String getCreateUser()
                               throws BusinessObjectException
Gets the name of the user that created this role.

Returns:
the value in the field CreateUser
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateUser

public java.lang.String getLastUpdateUser()
                                   throws BusinessObjectException
Gets the name of the user that last updated this role.

Returns:
the value in the field LastUpdateUser
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCalculateCostFromUnits

public boolean getCalculateCostFromUnits()
                                  throws BusinessObjectException
Gets the option that indicates whether costs and quantities are linked, and whether quantities should be updated when costs are updated.

Returns:
the value in the field CalculateCostFromUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setCalculateCostFromUnits

public void setCalculateCostFromUnits(boolean b)
                               throws BusinessObjectException
Sets the option that indicates whether costs and quantities are linked, and whether quantities should be updated when costs are updated.

Parameters:
b - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getProjectRoleSpreads

public ProjectRoleSpread[] getProjectRoleSpreads()
                                          throws BusinessObjectException
Gets the field containing project spread data for this role. If a role is attempted to be loaded with project spread data, getProjectRoleSpread will return null if no project spread data was available for that role. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field ProjectRoleSpread
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRequiredCreateFields

public static java.lang.String[] getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. Generally the array will contain one field in each position, but if this business object requires either one field or another field to be set, both of those fields will appear in an element of the returned array separated by '|'. For example, if this business object requires field A to always be set, and field B or field C to be set, one element in the returned array will contain A, and one element will contain B|C.

Returns:
String[] an array of required create fields

getFilterableFields

public static java.lang.String[] getFilterableFields()
Gets all fields that can be filtered.

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

public static java.lang.String[] getInternalDefaultLoadFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getAllFields

public static java.lang.String[] getAllFields()
Gets all fields for this business object.

Returns:
String[] an array of all fields

getInternalAllFields

public static java.lang.String[] getInternalAllFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getInternalAllFieldsSet

public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getRoleSpreadFields

public static java.lang.String[] getRoleSpreadFields()
Gets all spread fields that can be specified in the spreadFields parameter of loadWithProjectRoleSpread methods for this business object.

Returns:
String[] an array of all spread fields

getWritableFields

public static java.lang.String[] getWritableFields()
Gets all writable fields for this business object.

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

public static java.lang.String[] getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified.

Returns:
String[] an array of field names

getMinimumXMLExportFields

public static java.lang.String[] getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter

Returns:
String[] an array of exported fields

toString

public java.lang.String toString()
Returns a string representation of the object. The output is in XML.

Overrides:
toString in class java.lang.Object
Returns:
String a string representation of the object.

Primavera Integration API 7.0

Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.