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

Class RoleRate

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

Role rates enable you to select a predefined price per unit for cost calculating when assigning the role to an activity. 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. As resources, now roles can have different rates assigned to provide more flexibility for cost calculation. See also RateType, RateSource, and RateSourcePreference for more details on how rates can be used in cost calculation.

See Also:   Quick reference of RoleRate fields

  • Constructor Details

    • RoleRate

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

    • RoleRate

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

    • RoleRate

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

    • 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

    • 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

    • getRoleObjectId

      public ObjectId getRoleObjectId() throws BusinessObjectException
      Gets the unique ID of the associated role. 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 associated role. 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

    • getEffectiveDate

      public BeginDate getEffectiveDate() throws BusinessObjectException
      Gets the effective date for the role price and maximum units per time.
      Returns:
      the value in the field EffectiveDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setEffectiveDate

      public void setEffectiveDate(BeginDate d) throws BusinessObjectException
      Sets the effective date for the role price and maximum units per time.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getMaxUnitsPerTime

      public UnitsPerTime getMaxUnitsPerTime() throws BusinessObjectException
      Gets the maximum work units per time this role can perform on all their assigned activities. For example, a person working full time could perform 8 hours of work per day. A department of five people may perform at 5 days per day.
      Returns:
      the value in the field MaxUnitsPerTime
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setMaxUnitsPerTime

      public void setMaxUnitsPerTime(UnitsPerTime d) throws BusinessObjectException
      Sets the maximum work units per time this role can perform on all their assigned activities. For example, a person working full time could perform 8 hours of work per day. A department of five people may perform at 5 days per day.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPricePerUnit

      public Cost getPricePerUnit() throws BusinessObjectException
      Gets the non-overtime price per time for the role. This price is used to compute costs for any activities the role is assigned to. In general, cost = units * price per time.
      Returns:
      the value in the field PricePerUnit
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPricePerUnit

      public void setPricePerUnit(Cost c) throws BusinessObjectException
      Sets the non-overtime price per time for the role. This price is used to compute costs for any activities the role is assigned to. In general, cost = units * price per time.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPricePerUnit2

      public Cost getPricePerUnit2() throws BusinessObjectException
      Gets the non-overtime price per time for the role. This price is used to compute costs for any activities the role is assigned to. In general, cost = units * price per time.
      Returns:
      the value in the field PricePerUnit2
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPricePerUnit2

      public void setPricePerUnit2(Cost c) throws BusinessObjectException
      Sets the non-overtime price per time for the role. This price is used to compute costs for any activities the role is assigned to. In general, cost = units * price per time.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPricePerUnit3

      public Cost getPricePerUnit3() throws BusinessObjectException
      Gets the non-overtime price per time for the role. This price is used to compute costs for any activities the role is assigned to. In general, cost = units * price per time.
      Returns:
      the value in the field PricePerUnit3
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPricePerUnit3

      public void setPricePerUnit3(Cost c) throws BusinessObjectException
      Sets the non-overtime price per time for the role. This price is used to compute costs for any activities the role is assigned to. In general, cost = units * price per time.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPricePerUnit4

      public Cost getPricePerUnit4() throws BusinessObjectException
      Gets the non-overtime price per time for the role. This price is used to compute costs for any activities the role is assigned to. In general, cost = units * price per time.
      Returns:
      the value in the field PricePerUnit4
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPricePerUnit4

      public void setPricePerUnit4(Cost c) throws BusinessObjectException
      Sets the non-overtime price per time for the role. This price is used to compute costs for any activities the role is assigned to. In general, cost = units * price per time.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPricePerUnit5

      public Cost getPricePerUnit5() throws BusinessObjectException
      Gets the non-overtime price per time for the role. This price is used to compute costs for any activities the role is assigned to. In general, cost = units * price per time.
      Returns:
      the value in the field PricePerUnit5
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPricePerUnit5

      public void setPricePerUnit5(Cost c) throws BusinessObjectException
      Sets the non-overtime price per time for the role. This price is used to compute costs for any activities the role is assigned to. In general, cost = units * price per time.
      Parameters:
      c - the value to set this field to
      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 role.
      Returns:
      the value in the field RoleId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRoleName

      public 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 Date getCreateDate() throws BusinessObjectException
      Gets the date this role rate 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 rate 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 rate.
      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 rate.
      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 RoleRate object in the database.
      Returns:
      ObjectId the unique ID of the 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

    • create

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

    • load

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