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

Class RoleCode

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.base.RoleCodeBase
com.primavera.integration.client.bo.object.RoleCode
public class RoleCode extends com.primavera.integration.client.bo.base.RoleCodeBase

Role codes are user-defined codes to classify and categorize roles across the enterprise. They are defined globally.

With potentially hundreds of roles being used across an enterprise of projects, codes provide another method for filtering the roles you need to access quickly, or for grouping roles for analysis and summarization in layouts. You can also use role codes to group, sort, and filter roles in profiles and spreadsheets.

See Also:   Quick reference of RoleCode fields

  • Constructor Details

    • RoleCode

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

    • RoleCode

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

    • RoleCode

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

    • loadParentRoleCode

      public RoleCode loadParentRoleCode(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

    • createRoleCodeChild

      public ObjectId createRoleCodeChild(RoleCode rolecodechild) throws ServerException, NetworkException, BusinessObjectException
      Creates an associated RoleCode object in the database.
      Parameters:
      rolecodechild - RoleCodeChild object to create
      Returns:
      ObjectId unique ID of the newly created 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

    • createRoleCodeChildren

      public ObjectId[] createRoleCodeChildren(RoleCode[] rolecodechildren) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple associated RoleCode objects in the database.
      Parameters:
      rolecodechildren - array of RoleCodeChild objects to create
      Returns:
      ObjectId[] array of object ids of newly created RoleCode 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

    • loadRoleCodeChildren

      public BOIterator<RoleCode> loadRoleCodeChildren(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated RoleCode 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

    • loadRoleCodeAssignments

      public BOIterator<RoleCodeAssignment> loadRoleCodeAssignments(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated RoleCodeAssignment 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

    • loadRoles

      public BOIterator<Role> loadRoles(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Load the Role objects to which this role code is assigned.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order by clause
      Returns:
      iterator of Role objects
      Throws:
      ServerException
      NetworkException
      BusinessObjectException

    • getCodeTypeObjectId

      public ObjectId getCodeTypeObjectId() 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. 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 CodeTypeObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setCodeTypeObjectId

      public void setCodeTypeObjectId(ObjectId o) throws BusinessObjectException
      Sets 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. 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

    • getParentObjectId

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

    • getCodeValue

      public String getCodeValue() throws BusinessObjectException
      Gets the value of the role code. 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 CodeValue
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setCodeValue

      public void setCodeValue(String s) throws BusinessObjectException
      Sets the value of the role code. 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

    • getDescription

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

    • setDescription

      public void setDescription(String s) throws BusinessObjectException
      Sets the description of the role code.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCodeTypeName

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

    • getCreateDate

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

    • create

      public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
      Creates this RoleCode object in the database.
      Returns:
      ObjectId the unique ID of the newly created 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

    • create

      public static ObjectId[] create(Session session, RoleCode[] rolecodes) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple RoleCode objects in the database.
      Parameters:
      session - the Session object
      rolecodes - array of RoleCode objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created RoleCode 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 RoleCode load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single RoleCode object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the RoleCode object
      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

    • load

      public static BOIterator<RoleCode> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple RoleCode objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the RoleCode 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 RoleCode 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, RoleCode[] rolecodes) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple RoleCode objects in the database.
      Parameters:
      session - the Session object
      rolecodes - array of RoleCode 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 RoleCode 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, RoleCode[] rolecodes) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple RoleCode objects from the database.
      Parameters:
      session - the Session object
      rolecodes - array of RoleCode 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