Package com.primavera.integration.client.bo.object

Class RoleCodeAssignment

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.RoleCodeAssignment
public class RoleCodeAssignment extends BusinessObject

A role code assignment business object represents the assignment of a role code to a role. For each role code type, a role may have zero or one role codes assigned.

Note that this business object has a multi-part object ID; its object ID is a combination of its role object ID and its role code object ID. The method createObjectId() can be used to create the multi-part object ID from the individual IDs.

See Also:   Quick reference of RoleCodeAssignment fields

  • Constructor Details

    • RoleCodeAssignment

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

    • RoleCodeAssignment

      public RoleCodeAssignment(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 RoleObjectId and RoleCodeTypeObjectId 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

    • RoleCodeAssignment

      public RoleCodeAssignment(Session session, ObjectId roleObjectId, ObjectId roleCodeTypeObjectId) throws BusinessObjectException
      Class constructor specifying the Session and the individual components of the multi-part key: RoleObjectId and RoleCodeTypeObjectId. This constructor is most commonly used when update() is intended to be called on this object.
      Parameters:
      session - the Session
      roleObjectId - the first ObjectId in the key
      roleCodeTypeObjectId - the second ObjectId in the key
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • RoleCodeAssignment

      public RoleCodeAssignment(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 Details

    • loadRoleCodeType

      public RoleCodeType loadRoleCodeType(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated RoleCodeType object from the database.
      Parameters:
      fields - fields to load
      Returns:
      RoleCodeType the RoleCodeType 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

    • loadRoleCode

      public RoleCode loadRoleCode(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated RoleCode object from the database.
      Parameters:
      fields - fields to load
      Returns:
      RoleCode the RoleCode 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(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

    • getRoleObjectId

      public ObjectId getRoleObjectId() throws BusinessObjectException
      Gets the unique ID of the role to which the role code is assigned. This field is automatically loaded by default whenever this type of business object is loaded from the database. 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 role to which the role code is assigned. This field is automatically loaded by default whenever this type of business object is loaded from the database. 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

    • getRoleCodeTypeObjectId

      public ObjectId getRoleCodeTypeObjectId() throws BusinessObjectException
      Gets the unique ID of the parent role code type. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field RoleCodeTypeObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRoleCodeObjectId

      public ObjectId getRoleCodeObjectId() throws BusinessObjectException
      Gets the unique ID of the associated role code. This field is automatically loaded by default whenever this type of business object is loaded from the database. 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 RoleCodeObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRoleCodeObjectId

      public void setRoleCodeObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated role code. This field is automatically loaded by default whenever this type of business object is loaded from the database. 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

    • getRoleCodeTypeName

      public String getRoleCodeTypeName() throws BusinessObjectException
      Gets the name of the parent role code type.
      Returns:
      the value in the field RoleCodeTypeName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRoleCodeDescription

      public String getRoleCodeDescription() throws BusinessObjectException
      Gets the description of the associated role code.
      Returns:
      the value in the field RoleCodeDescription
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRoleCodeValue

      public String getRoleCodeValue() throws BusinessObjectException
      Gets the value of the associated role code.
      Returns:
      the value in the field RoleCodeValue
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRoleName

      public String getRoleName() throws BusinessObjectException
      Gets the name of the role to which the role code is assigned.
      Returns:
      the value in the field RoleName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRoleId

      public String getRoleId() throws BusinessObjectException
      Gets the short code that uniquely identifies the associated role.
      Returns:
      the value in the field RoleId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateDate

      public Date getCreateDate() throws BusinessObjectException
      Gets the date this code assignment was created.
      Returns:
      the value in the field CreateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLastUpdateDate

      public Date getLastUpdateDate() throws BusinessObjectException
      Gets the date this code assignment was last updated.
      Returns:
      the value in the field LastUpdateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateUser

      public String getCreateUser() throws BusinessObjectException
      Gets the name of the user that created this code assignment.
      Returns:
      the value in the field CreateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLastUpdateUser

      public String getLastUpdateUser() throws BusinessObjectException
      Gets the name of the user that last updated this code assignment.
      Returns:
      the value in the field LastUpdateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRequiredCreateFields

      public static 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 String[] getFilterableFields()
      Gets all fields that can be filtered.
      Returns:
      String[] an array of filterable fields

    • getInternalDefaultLoadFields

      public static String[] getInternalDefaultLoadFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getAllFields

      public static String[] getAllFields()
      Gets all fields for this business object.
      Returns:
      String[] an array of all fields

    • getInternalAllFields

      public static String[] getInternalAllFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getInternalAllFieldsSet

      public static Set<String> getInternalAllFieldsSet()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getWritableFields

      public static String[] getWritableFields()
      Gets all writable fields for this business object.
      Returns:
      String[] an array of writable fields

    • getDefaultXMLExportFields

      @Deprecated public static String[] getDefaultXMLExportFields()
      Deprecated.
      Gets the fields that are exported by the hierarchical XML exporter when no fields are specified. This method is no longer relevant since the hierarchical XML exporter has been replaced by the flat XML exporter.
      Returns:
      String[] an array of field names

    • getMinimumXMLExportFields

      public static 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 String toString()
      Returns a string representation of the object. The output is in XML.
      Overrides:
      toString in class Object
      Returns:
      String a string representation of the object.

    • createObjectId

      public static ObjectId createObjectId(ObjectId roleObjectId, ObjectId roleCodeTypeObjectId) throws InvalidValueException
      Creates a multi-part ObjectId from two individual ObjectIds.
      Parameters:
      roleObjectId - the ObjectId of the associated role object.
      roleCodeTypeObjectId - the ObjectId of the associated roleCodeType object.
      Returns:
      ObjectId the multi-part ObjectId
      Throws:
      InvalidValueException - if one of the input parameters was invalid.
      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 RoleObjectId and RoleCodeTypeObjectId 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 RoleCodeAssignment object in the database.
      Returns:
      ObjectId the unique ID of the newly created RoleCodeAssignment 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, RoleCodeAssignment[] rolecodeassignments) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple RoleCodeAssignment objects in the database.
      Parameters:
      session - the Session object
      rolecodeassignments - array of RoleCodeAssignment objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created RoleCodeAssignment 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 RoleCodeAssignment load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single RoleCodeAssignment object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the RoleCodeAssignment object
      Returns:
      RoleCodeAssignment the RoleCodeAssignment 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<RoleCodeAssignment> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple RoleCodeAssignment objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the RoleCodeAssignment 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 RoleCodeAssignment object in the database.
      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, RoleCodeAssignment[] rolecodeassignments) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple RoleCodeAssignment objects in the database.
      Parameters:
      session - the Session object
      rolecodeassignments - array of RoleCodeAssignment 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 RoleCodeAssignment object from the database.
      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, RoleCodeAssignment[] rolecodeassignments) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple RoleCodeAssignment objects from the database.
      Parameters:
      session - the Session object
      rolecodeassignments - array of RoleCodeAssignment 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