Primavera Integration API 7.0

com.primavera.integration.client.bo.object
Class ResourceHour

java.lang.Object
  extended by com.primavera.integration.client.BOBase
      extended by com.primavera.integration.client.bo.BusinessObject
          extended by 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 Summary
ResourceHour(Session session)
          Class constructor specifying the Session.
ResourceHour(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
ResourceHour(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)
          Class constructor called internally after objects are retrieved from the server.
 
Method Summary
 ObjectId getActivityObjectId()
          Gets the unique ID of the activity to which the resource is assigned.
 boolean getActivityTimesheetLinkFlag()
          Gets the value which indicates if the record is a real timesheet entry (false) or simply a placeholder for a timesheet entry (true).
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 double getApprovedHours()
          Gets the number of hours, approved.
 double getApprovedOvertimeHours()
          Gets the number of overtime hours, approved.
 java.util.Date getCreateDate()
          Gets the date this data was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this data.
 java.util.Date getDate()
          Gets the date to which the hours apply.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
static java.lang.String[] getFilterableFields()
          Gets all fields that can be filtered.
static java.lang.String[] getInternalAllFields()
          An internal method that should not be called directly by client code.
static java.util.Set<java.lang.String> getInternalAllFieldsSet()
          An internal method that should not be called directly by client code.
static java.lang.String[] getInternalDefaultLoadFields()
          An internal method that should not be called directly by client code.
 boolean getIsBaseline()
          Gets the boolean value indicating if this business object is related to a Project or Baseline.
 java.util.Date getLastUpdateDate()
          Gets the date this data was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this data.
static java.lang.String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 ObjectId getObjectId()
          Gets the unique ID generated by the system.
 java.lang.String getOverheadCodeName()
          Gets the name of the overhead code.
 ObjectId getOverheadCodeObjectId()
          Gets the unique ID of the overhead code, if the hours are for an overhead activity.
 java.lang.String getProjectId()
          Gets the short code that uniquely identifies the project.
 java.lang.String getProjectName()
          Gets the name of the associated project.
 ObjectId getProjectObjectId()
          Gets the unique ID of the associated project.
 ObjectId getResourceAssignmentObjectId()
          Gets the unique ID of the associated resource assignment.
 java.lang.String getResourceId()
          Gets the short code that uniquely identifies the resource.
 java.lang.String getResourceName()
          Gets the name of the resource.
 ObjectId getResourceObjectId()
          Gets the unique ID of the associated resource.
 ResourceHourStatus getStatus()
          Gets the approval level, when timesheets require approval: 'Submitted', 'Approved', 'Resource Manager Approved', 'Project Manager Approved', 'Active', or 'Rejected'.
 ObjectId getTimesheetPeriodObjectId()
          Gets the unique ID of the associated timesheet.
 double getUnapprovedHours()
          Gets the actual non-overtime units submitted by the resource on the activity.
 double getUnapprovedOvertimeHours()
          Gets the actual overtime units submitted by the resource on the acitivity.
 ObjectId getWBSObjectId()
          Gets the unique ID of the WBS for the activity.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static ResourceHour load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single ResourceHour object from the database.
static BOIterator<ResourceHour> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple ResourceHour objects from the database.
 OverheadCode loadOverheadCode(java.lang.String[] fields)
          Loads an associated OverheadCode object from the database.
 Project loadProject(java.lang.String[] fields)
          Loads an associated Project object from the database.
 Resource loadResource(java.lang.String[] fields)
          Loads an associated Resource object from the database.
 ResourceAssignment loadResourceAssignment(java.lang.String[] fields)
          Loads an associated ResourceAssignment object from the database.
 Timesheet loadTimesheet(java.lang.String[] fields)
          Loads an associated Timesheet object from the database.
 TimesheetPeriod loadTimesheetPeriod(java.lang.String[] fields)
          Loads an associated TimesheetPeriod object from the database.
 java.lang.String toString()
          Returns a string representation of the object.
 
Methods inherited from class com.primavera.integration.client.bo.BusinessObject
equals, hashCode, isNull, setNull, setObjectId
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

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.

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 Detail

load

public static ResourceHour load(Session session,
                                java.lang.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,
                                            java.lang.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

loadResourceAssignment

public ResourceAssignment loadResourceAssignment(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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.

Overrides:
getObjectId in class BusinessObject
Returns:
the value in the field ObjectId
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

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

getOverheadCodeName

public java.lang.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

getResourceName

public java.lang.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 java.lang.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

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

getDate

public java.util.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

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

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

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

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

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

getProjectName

public java.lang.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

getProjectId

public java.lang.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

getCreateDate

public java.util.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 java.util.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 java.lang.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 java.lang.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

getFilterableFields

public static java.lang.String[] getFilterableFields()
Gets all fields that can be filtered.

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

public static java.lang.String[] getInternalDefaultLoadFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getAllFields

public static java.lang.String[] getAllFields()
Gets all fields for this business object.

Returns:
String[] an array of all fields

getInternalAllFields

public static java.lang.String[] getInternalAllFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getInternalAllFieldsSet

public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getWritableFields

public static java.lang.String[] getWritableFields()
Gets all writable fields for this business object.

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

public static java.lang.String[] getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified.

Returns:
String[] an array of field names

getMinimumXMLExportFields

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

Overrides:
toString in class java.lang.Object
Returns:
String a string representation of the object.

Primavera Integration API 7.0

Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.