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

Class RoleTeam

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

A role team consists of roles grouped together in some way that is meaningful to you.

To add a role to a team, use one of the addRole() or addRoles() methods. Use one of the removeRole() or removeRoles() methods to remove a role from a team. These methods will not cause the role(s) to be deleted.

To determine if a role is in this team, use one of the containsRole() methods. The getRoleIds() method will return an array of the ObjectIds of all roles in the team.

To load all or some of the roles contained in this team, use the loadRoles() method.

See Also:   Quick reference of RoleTeam fields

  • Constructor Details

    • RoleTeam

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

    • RoleTeam

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

    • RoleTeam

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

    • loadUser

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

    • addRole

      public void addRole(Role role) throws BusinessObjectException
      Adds a role into the role team.
      Parameters:
      role - Role object to add
      Throws:
      BusinessObjectException

    • addRoles

      public void addRoles(Role[] roles) throws BusinessObjectException
      Adds roles into the role team.
      Parameters:
      roles - Array of Role objects to add
      Throws:
      BusinessObjectException

    • addRole

      public void addRole(ObjectId objId) throws BusinessObjectException
      Adds a role into the role team.
      Parameters:
      objId - unique ID of a Role object to add
      Throws:
      BusinessObjectException

    • addRoles

      public void addRoles(ObjectId[] objIds) throws BusinessObjectException
      Adds roles into the role team.
      Parameters:
      objIds - Array of Role unique IDs to add
      Throws:
      BusinessObjectException

    • removeRole

      public void removeRole(Role role) throws BusinessObjectException
      Removes a role from the role team.
      Parameters:
      role - Role object to remove
      Throws:
      BusinessObjectException

    • removeRoles

      public void removeRoles(Role[] roles) throws BusinessObjectException
      Removes roles from the role team.
      Parameters:
      roles - Array of Role objects
      Throws:
      BusinessObjectException

    • removeRole

      public void removeRole(ObjectId objId) throws BusinessObjectException
      Removes a role from the role team.
      Parameters:
      objId - unique ID of a Role object
      Throws:
      BusinessObjectException

    • removeRoles

      public void removeRoles(ObjectId[] objIds) throws BusinessObjectException
      Removes roles from the role team.
      Parameters:
      objIds - Array of Role unique IDs
      Throws:
      BusinessObjectException

    • containsRole

      public boolean containsRole(Role role) throws BusinessObjectException
      Indicates if the role is in the role team.
      Parameters:
      role - Role object
      Returns:
      boolean whether the role team contains the specified Roles
      Throws:
      BusinessObjectException

    • containsRole

      public boolean containsRole(ObjectId objId) throws BusinessObjectException
      Indicates if the role is in the role team.
      Parameters:
      objId - unique ID of a Role object
      Returns:
      boolean whether the portfolio contains the specified Role
      Throws:
      BusinessObjectException

    • getRoleObjectIds

      public ObjectId[] getRoleObjectIds() throws BusinessObjectException
      Gets an array of role unique IDs contained in the role team.
      Returns:
      ObjectId[] array of role unique IDs contained in the role team
      Throws:
      BusinessObjectException

    • loadRoles

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

    • 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

    • getUserObjectId

      public ObjectId getUserObjectId() throws BusinessObjectException
      Gets the unique ID of a specific user who has access to the selected role team. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field UserObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setUserObjectId

      public void setUserObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of a specific user who has access to the selected role team. 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

    • getName

      public String getName() throws BusinessObjectException
      Gets the name of the role team. 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(String s) throws BusinessObjectException
      Sets the name of the role team. 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 team.
      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 team.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getUserName

      public String getUserName() throws BusinessObjectException
      Gets the user's login name.
      Returns:
      the value in the field UserName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateDate

      public Date getCreateDate() throws BusinessObjectException
      Gets the date this role team 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 team 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 team.
      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 team.
      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 RoleTeam object in the database.
      Returns:
      ObjectId the unique ID of the newly created RoleTeam 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, RoleTeam[] roleteams) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple RoleTeam objects in the database.
      Parameters:
      session - the Session object
      roleteams - array of RoleTeam objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created RoleTeam 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 RoleTeam load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single RoleTeam object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the RoleTeam object
      Returns:
      RoleTeam the RoleTeam 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<RoleTeam> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple RoleTeam objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the RoleTeam 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 RoleTeam 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, RoleTeam[] roleteams) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple RoleTeam objects in the database.
      Parameters:
      session - the Session object
      roleteams - array of RoleTeam 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 RoleTeam 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, RoleTeam[] roleteams) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple RoleTeam objects from the database.
      Parameters:
      session - the Session object
      roleteams - array of RoleTeam 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