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

Class ResourceHour

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

A resource hour corresponds to an entry on a timesheet edited in Timesheets. Resource hours may not be exported directly by the XMLExporter, but all child resource hours are exported automatically when exporting timesheets. Resource hours are read only.

See Also:   Quick reference of ResourceHour fields

  • Constructor Details

    • ResourceHour

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

    • ResourceHour

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

    • ResourceHour

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

    • loadResourceAssignment

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

    • loadResource

      public Resource loadResource(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

    • loadTimesheetPeriod

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

    • loadTimesheet

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

    • loadOverheadCode

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

    • loadProject

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

    • getResourceAssignmentObjectId

      public ObjectId getResourceAssignmentObjectId() throws BusinessObjectException
      Gets the unique ID of the associated resource assignment. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field ResourceAssignmentObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setResourceAssignmentObjectId

      public void setResourceAssignmentObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated resource assignment. 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

    • getActivityObjectId

      public ObjectId getActivityObjectId() throws BusinessObjectException
      Gets the unique ID of the activity to which the resource is assigned.
      Returns:
      the value in the field ActivityObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getWBSObjectId

      public ObjectId getWBSObjectId() throws BusinessObjectException
      Gets the unique ID of the WBS for the activity. 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 WBSObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getOverheadCodeObjectId

      public ObjectId getOverheadCodeObjectId() throws BusinessObjectException
      Gets the unique ID of the overhead code, if the hours are for an overhead activity. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field OverheadCodeObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setOverheadCodeObjectId

      public void setOverheadCodeObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the overhead code, if the hours are for an overhead activity. 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

    • getOverheadCodeName

      public String getOverheadCodeName() throws BusinessObjectException
      Gets the name of the overhead code.
      Returns:
      the value in the field OverheadCodeName
      Throws:
      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 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 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 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

    • getResourceName

      public 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

    • getResourceId

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

    • getResourceIntegratedType

      public IntegratedObjectType getResourceIntegratedType() throws BusinessObjectException
      Gets the flag indicating whether the resource is integrated with an Enterprise Resource Planning (ERP) system. 'Fusion' indicates the resource is integrated with Oracle Fusion. 'ERP' indicates the resource is integrated with another ERP system.
      Returns:
      the value in the field ResourceIntegratedType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getStatus

      public ResourceHourStatus getStatus() throws BusinessObjectException
      Gets the approval level, when timesheets require approval: 'Submitted', 'Approved', 'Resource Manager Approved', 'Project Manager Approved', 'Active', or 'Rejected'.
      Returns:
      the value in the field Status
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setStatus

      public void setStatus(ResourceHourStatus enm) throws BusinessObjectException
      Sets the approval level, when timesheets require approval: 'Submitted', 'Approved', 'Resource Manager Approved', 'Project Manager Approved', 'Active', or 'Rejected'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getDate

      public Date getDate() throws BusinessObjectException
      Gets the date to which the hours apply.
      Returns:
      the value in the field Date
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setDate

      public void setDate(Date d) throws BusinessObjectException
      Sets the date to which the hours apply.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getApprovedHours

      public double getApprovedHours() throws BusinessObjectException
      Gets the number of hours, approved.
      Returns:
      the value in the field ApprovedHours
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setApprovedHours

      public void setApprovedHours(double d) throws BusinessObjectException
      Sets the number of hours, approved.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getApprovedOvertimeHours

      public double getApprovedOvertimeHours() throws BusinessObjectException
      Gets the number of overtime hours, approved.
      Returns:
      the value in the field ApprovedOvertimeHours
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setApprovedOvertimeHours

      public void setApprovedOvertimeHours(double d) throws BusinessObjectException
      Sets the number of overtime hours, approved.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActivityTimesheetLinkFlag

      public boolean getActivityTimesheetLinkFlag() throws BusinessObjectException
      Gets the value which indicates if the record is a real timesheet entry (false) or simply a placeholder for a timesheet entry (true).
      Returns:
      the value in the field ActivityTimesheetLinkFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActivityTimesheetLinkFlag

      public void setActivityTimesheetLinkFlag(boolean b) throws BusinessObjectException
      Sets the value which indicates if the record is a real timesheet entry (false) or simply a placeholder for a timesheet entry (true).
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getUnapprovedHours

      public double getUnapprovedHours() throws BusinessObjectException
      Gets the actual non-overtime units submitted by the resource on the activity. These units remain submitted until the timesheet is approved.
      Returns:
      the value in the field UnapprovedHours
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setUnapprovedHours

      public void setUnapprovedHours(double d) throws BusinessObjectException
      Sets the actual non-overtime units submitted by the resource on the activity. These units remain submitted until the timesheet is approved.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getUnapprovedOvertimeHours

      public double getUnapprovedOvertimeHours() throws BusinessObjectException
      Gets the actual overtime units submitted by the resource on the acitivity. These units remain submitted until the timesheet is approved.
      Returns:
      the value in the field UnapprovedOvertimeHours
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setUnapprovedOvertimeHours

      public void setUnapprovedOvertimeHours(double d) throws BusinessObjectException
      Sets the actual overtime units submitted by the resource on the acitivity. These units remain submitted until the timesheet is approved.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getProjectName

      public String getProjectName() throws BusinessObjectException
      Gets the name of the associated project.
      Returns:
      the value in the field ProjectName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getProjectObjectId

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

    • setProjectObjectId

      public void setProjectObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated project. 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

    • getProjectId

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

    • getTimesheetPeriodObjectId

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

    • setTimesheetPeriodObjectId

      public void setTimesheetPeriodObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated timesheet. 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

    • getTimesheetStatusDate

      public Date getTimesheetStatusDate() throws BusinessObjectException
      Gets the status date of the associated timesheet.
      Returns:
      the value in the field TimesheetStatusDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateDate

      public Date getCreateDate() throws BusinessObjectException
      Gets the date this data 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 data 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 data.
      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 data.
      Returns:
      the value in the field LastUpdateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsBaseline

      public boolean getIsBaseline() throws BusinessObjectException
      Gets the boolean value indicating if this business object is related to a Project or Baseline.
      Returns:
      the value in the field IsBaseline
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsTemplate

      public boolean getIsTemplate() throws BusinessObjectException
      Gets the boolean value indicating if this business object is related to a template Project.
      Returns:
      the value in the field IsTemplate
      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 ResourceHour object in the database.
      Returns:
      ObjectId the unique ID of the newly created ResourceHour 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, ResourceHour[] resourcehours) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple ResourceHour objects in the database.
      Parameters:
      session - the Session object
      resourcehours - array of ResourceHour objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created ResourceHour 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 ResourceHour load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single ResourceHour object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the ResourceHour object
      Returns:
      ResourceHour the ResourceHour 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<ResourceHour> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple ResourceHour objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the ResourceHour 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 ResourceHour 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, ResourceHour[] resourcehours) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple ResourceHour objects in the database.
      Parameters:
      session - the Session object
      resourcehours - array of ResourceHour 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 ResourceHour 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, ResourceHour[] resourcehours) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple ResourceHour objects from the database.
      Parameters:
      session - the Session object
      resourcehours - array of ResourceHour 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