|
Primavera Integration API 7.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.TimesheetAudit
public class TimesheetAudit
The timesheet audit class facilitates reading the timesheet audit records, added to the PM database as triggered by user activity, one record at a time. Fields that can be loaded on the TimesheetAudit object include information about the approval and rejection history (e.g., reviewers and review dates), information about the timesheets (e.g., number of overhead, overtime, and project hours), and information about the audit (e.g, the date the timesheet audit was created). Timesheet audits are readonly.
See Also: Quick reference of TimesheetAudit fields
Constructor Summary | |
---|---|
TimesheetAudit(Session session)
Class constructor specifying the Session. |
|
TimesheetAudit(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
TimesheetAudit(Session session,
com.primavera.infr.db.PrmRowSet rowSet,
int iIndex)
Class constructor called internally after objects are retrieved from the server. |
Method Summary | |
---|---|
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
java.lang.String |
getApproverUserName()
Gets the user name of the approver. |
ObjectId |
getApproverUserObjectId()
Gets the unique user ID of the approver. |
java.util.Date |
getAuditDate()
Gets the date this timesheet audit was created. |
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. |
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. |
double |
getOverheadHours()
Gets the total overhead hours for the timesheet. |
double |
getOverheadOvertimeHours()
Gets the total overhead overtime hours for the timesheet. |
double |
getPendingOverheadHours()
Gets the total pending overhead hours for the timesheet. |
double |
getPendingOverheadOvertimeHours()
Gets the total pending overhead overtime hours for the timesheet. |
double |
getPendingProjectHours()
Gets the total pending project hours for the timesheet. |
double |
getPendingProjectOvertimeHours()
Gets the total pending project overtime hours for the timesheet. |
double |
getProjectHours()
Gets the total project hours for the timesheet. |
java.lang.String |
getProjectId()
Gets the short code that uniquely identifies the project. |
ObjectId |
getProjectObjectId()
Gets the unique ID of the associated project. |
double |
getProjectOvertimeHours()
Gets the total project overtime hours for the timesheet. |
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 |
getTimesheetActivityStatus()
Gets the status of the timesheet activity, the value of which will depend on who approved or rejected it. |
TimesheetApprovingAs |
getTimesheetApprovingAs()
Gets the role of the timesheet approver. |
java.util.Date |
getTimesheetPeriodEndDate()
Gets the timesheet period end date. |
ObjectId |
getTimesheetPeriodObjectId()
Gets the unique ID of the timesheet period. |
java.util.Date |
getTimesheetPeriodStartDate()
Gets the timesheet period start date. |
TimesheetStatus |
getTimesheetStatus()
Gets the status of the timesheet. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static TimesheetAudit |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single TimesheetAudit object from the database. |
static BOIterator<TimesheetAudit> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple TimesheetAudit objects 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 |
---|
public TimesheetAudit(Session session)
session
- the Sessionpublic TimesheetAudit(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic TimesheetAudit(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 static TimesheetAudit load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the TimesheetAudit 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<TimesheetAudit> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the TimesheetAudit 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 objectspublic ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getAuditDate() 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 java.lang.String getResourceId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getResourceName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic TimesheetStatus getTimesheetStatus() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getProjectHours() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getProjectOvertimeHours() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getPendingProjectHours() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getPendingProjectOvertimeHours() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getOverheadHours() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getOverheadOvertimeHours() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getPendingOverheadHours() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getPendingOverheadOvertimeHours() 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 java.util.Date getTimesheetPeriodStartDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getTimesheetPeriodEndDate() 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 java.lang.String getProjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ResourceHourStatus getTimesheetActivityStatus() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getApproverUserObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getApproverUserName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic TimesheetApprovingAs getTimesheetApprovingAs() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static java.lang.String[] getFilterableFields()
public static java.lang.String[] getInternalDefaultLoadFields()
public static java.lang.String[] getAllFields()
public static java.lang.String[] getInternalAllFields()
public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
public static java.lang.String[] getWritableFields()
public static java.lang.String[] getDefaultXMLExportFields()
public static java.lang.String[] getMinimumXMLExportFields()
public java.lang.String toString()
toString
in class java.lang.Object
|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |