|
Primavera Integration API 8.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.ResourceHour
public class ResourceHour
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 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. |
Date |
getCreateDate()
Gets the date this data was created. |
String |
getCreateUser()
Gets the name of the user that created this data. |
Date |
getDate()
Gets the date to which the hours apply. |
static String[] |
getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified. |
static String[] |
getFilterableFields()
Gets all fields that can be filtered. |
static String[] |
getInternalAllFields()
An internal method that should not be called directly by client code. |
static Set<String> |
getInternalAllFieldsSet()
An internal method that should not be called directly by client code. |
static 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. |
boolean |
getIsTemplate()
Gets the boolean value indicating if this business object is related to a template Project. |
Date |
getLastUpdateDate()
Gets the date this data was last updated. |
String |
getLastUpdateUser()
Gets the name of the user that last updated this data. |
static 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. |
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. |
String |
getProjectId()
Gets the short code that uniquely identifies the project. |
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. |
String |
getResourceId()
Gets the short code that uniquely identifies the resource. |
IntegratedObjectType |
getResourceIntegratedType()
Gets the flag indicating whether the resource is integrated with an Enterprise Resource Planning (ERP) system. |
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. |
Date |
getTimesheetStatusDate()
Gets the status date 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 String[] |
getWritableFields()
Gets all writable fields for this business object. |
static ResourceHour |
load(Session session,
String[] fields,
ObjectId objId)
Loads a single ResourceHour object from the database. |
static BOIterator<ResourceHour> |
load(Session session,
String[] fields,
ObjectId[] objIds)
Loads multiple ResourceHour objects from the database. |
OverheadCode |
loadOverheadCode(String[] fields)
Loads an associated OverheadCode object from the database. |
Project |
loadProject(String[] fields)
Loads an associated Project object from the database. |
Resource |
loadResource(String[] fields)
Loads an associated Resource object from the database. |
ResourceAssignment |
loadResourceAssignment(String[] fields)
Loads an associated ResourceAssignment object from the database. |
Timesheet |
loadTimesheet(String[] fields)
Loads an associated Timesheet object from the database. |
TimesheetPeriod |
loadTimesheetPeriod(String[] fields)
Loads an associated TimesheetPeriod object from the database. |
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 |
---|
public ResourceHour(Session session)
session
- the Sessionpublic ResourceHour(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ResourceHour(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
session
- the SessionrowSet
- the PrmRowSet retrieved from the serveriIndex
- the row index in the PrmRowSet associated with this business object
BusinessObjectException
- if a problem occurred in the client-side business objectsMethod Detail |
---|
public ResourceAssignment loadResourceAssignment(String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic Resource loadResource(String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic TimesheetPeriod loadTimesheetPeriod(String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic Timesheet loadTimesheet(String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic OverheadCode loadOverheadCode(String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic Project loadProject(String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getResourceAssignmentObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getActivityObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getWBSObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getOverheadCodeObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getOverheadCodeName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getResourceObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getResourceName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getResourceId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic IntegratedObjectType getResourceIntegratedType() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ResourceHourStatus getStatus() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Date getDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getApprovedHours() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getApprovedOvertimeHours() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getActivityTimesheetLinkFlag() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getUnapprovedHours() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getUnapprovedOvertimeHours() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getProjectName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getProjectObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getProjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getTimesheetPeriodObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Date getTimesheetStatusDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Date getCreateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Date getLastUpdateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getCreateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getLastUpdateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsBaseline() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsTemplate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static String[] getFilterableFields()
public static String[] getInternalDefaultLoadFields()
public static String[] getAllFields()
public static String[] getInternalAllFields()
public static Set<String> getInternalAllFieldsSet()
public static String[] getWritableFields()
public static String[] getDefaultXMLExportFields()
public static String[] getMinimumXMLExportFields()
public String toString()
toString
in class Object
public static ResourceHour load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ResourceHour object
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 objectspublic static BOIterator<ResourceHour> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ResourceHour objects
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
|
Primavera Integration API 8.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |