Primavera Integration API 7.0

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

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.ResourceRole

public class ResourceRole
extends BusinessObject

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

ResourceRole

public ResourceRole(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

ResourceRole

public ResourceRole(Session session,
                    ObjectId objId)
             throws BusinessObjectException
Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() is intended to be called on this object. For this particular object, the ObjectId is multi-part, created from the ResourceObjectId and RoleObjectId field values. If you do not have the multi-part ObjectId already, it would be simpler to instead use the constructor that has multiple key parameters.

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

ResourceRole

public ResourceRole(Session session,
                    ObjectId resourceObjectId,
                    ObjectId roleObjectId)
             throws BusinessObjectException
Class constructor specifying the Session and the individual components of the multi-part key: ResourceObjectId and RoleObjectId. This constructor is most commonly used when update() is intended to be called on this object.

Parameters:
session - the Session
resourceObjectId - the first ObjectId in the key
roleObjectId - the second ObjectId in the key
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

ResourceRole

public ResourceRole(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

createObjectId

public static ObjectId createObjectId(ObjectId resourceObjectId,
                                      ObjectId roleObjectId)
                               throws InvalidValueException
Creates a multi-part ObjectId from two individual ObjectIds.

Parameters:
resourceObjectId - the ObjectId of the associated resource object.
roleObjectId - the ObjectId of the associated role object.
Returns:
ObjectId the multi-part ObjectId
Throws:
InvalidValueException - if one of the input parameters was invalid.
java.lang.IllegalArgumentException - if one of the input parameters was null.

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the ObjectId for this object. The ObjectId field serves as the primary key for the associated table in the database. For this object, the ObjectId is multi-part, consisting internally of the ResourceObjectId and RoleObjectId fields.

Overrides:
getObjectId in class BusinessObject
Returns:
ObjectId the multi-part ObjectId of this object
Throws:
BusinessObjectException - if the ObjectId fields were not loaded.

create

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

Returns:
ObjectId the unique ID of the newly created ResourceRole 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,
                                ResourceRole[] resourceroles)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple ResourceRole objects in the database.

Parameters:
session - the Session object
resourceroles - array of ResourceRole objects to create
Returns:
ObjectId[] the array of unique IDs of newly created ResourceRole 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 ResourceRole load(Session session,
                                java.lang.String[] fields,
                                ObjectId objId)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Loads a single ResourceRole object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the ResourceRole object
Returns:
ResourceRole the ResourceRole 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<ResourceRole> load(Session session,
                                            java.lang.String[] fields,
                                            ObjectId[] objIds)
                                     throws ServerException,
                                            NetworkException,
                                            BusinessObjectException
Loads multiple ResourceRole objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the ResourceRole 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

update

public void update()
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Updates this ResourceRole 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,
                          ResourceRole[] resourceroles)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple ResourceRole objects in the database.

Parameters:
session - the Session object
resourceroles - array of ResourceRole 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 ResourceRole 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 static void delete(Session session,
                          ResourceRole[] resourceroles)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple ResourceRole objects from the database.

Parameters:
session - the Session object
resourceroles - array of ResourceRole 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

loadResource

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

Parameters:
fields - fields to load
Returns:
Resource the Resource 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

loadRole

public Role loadRole(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

getResourceObjectId

public ObjectId getResourceObjectId()
                             throws BusinessObjectException
Gets the unique ID of the associated resource. 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 ResourceObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setResourceObjectId

public void setResourceObjectId(ObjectId o)
                         throws BusinessObjectException
Sets the unique ID of the associated resource. This field must contain a valid value in order to create this type of business object in the database.

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

getRoleObjectId

public ObjectId getRoleObjectId()
                         throws BusinessObjectException
Gets the unique ID of the associated 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 RoleObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setRoleObjectId

public void setRoleObjectId(ObjectId o)
                     throws BusinessObjectException
Sets the unique ID of the associated role. This field must contain a valid value in order to create this type of business object in the database.

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

getProficiency

public Proficiency getProficiency()
                           throws BusinessObjectException
Gets the resource's proficiency at performing this role. The values are '1 - Master', '2 - Expert', '3 - Skilled', '4 - Proficient', and '5 - Inexperienced'. If the current user does not have the ViewResourceRoleProficiency global security privilege, this field may not be accessed. 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 Proficiency
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setProficiency

public void setProficiency(Proficiency enm)
                    throws BusinessObjectException
Sets the resource's proficiency at performing this role. The values are '1 - Master', '2 - Expert', '3 - Skilled', '4 - Proficient', and '5 - Inexperienced'. If the current user does not have the ViewResourceRoleProficiency global security privilege, this field may not be accessed. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getResourceId

public java.lang.String getResourceId()
                               throws BusinessObjectException
Gets the short code that uniquely identifies the resource. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

getResourceName

public java.lang.String getResourceName()
                                 throws BusinessObjectException
Gets the name of the resource.

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

getRoleId

public java.lang.String getRoleId()
                           throws BusinessObjectException
Gets the short code that uniquely identifies the role. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

getRoleName

public java.lang.String getRoleName()
                             throws BusinessObjectException
Gets the name of the role. The role name uniquely identifies the role.

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

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this resource 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 resource 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 resource 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 resource role.

Returns:
the value in the field LastUpdateUser
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

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.