|
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.Timesheet
public class Timesheet
Timesheets are used to allow resources to enter status. Timesheets are read only in the Integration API.
This business object has a multi-part object ID; its object ID is a combination of its timesheet period object ID and its resource object ID. The method createObjectId() can be used to create the multi-part object ID from the individual IDs.
See Also: Quick reference of Timesheet fields
Constructor Summary | |
---|---|
Timesheet(Session session)
Class constructor specifying the Session. |
|
Timesheet(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
Timesheet(Session session,
ObjectId timesheetPeriodObjectId,
ObjectId resourceObjectId)
Class constructor specifying the Session and the individual components of the multi-part key: TimesheetPeriodObjectId and ResourceObjectId. |
|
Timesheet(Session session,
com.primavera.infr.db.PrmRowSet rowSet,
int iIndex)
Class constructor called internally after objects are retrieved from the server. |
Method Summary | |
---|---|
static ObjectId |
createObjectId(ObjectId timesheetPeriodObjectId,
ObjectId resourceObjectId)
Creates a multi-part ObjectId from two individual ObjectIds. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
java.util.Date |
getCreateDate()
Gets the date this timesheet was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this timesheet. |
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 |
getIsDaily()
Gets the flag that identifies whether timesheet users enter hours daily or by entire timesheet reporting period. |
java.util.Date |
getLastReceivedDate()
Gets the last date on which the timesheet was submitted by the resource. |
java.util.Date |
getLastUpdateDate()
Gets the date this timesheet was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this timesheet. |
static java.lang.String[] |
getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter |
java.lang.String |
getNotes()
Gets the notes associated with the timesheet. |
ObjectId |
getObjectId()
Gets the ObjectId for this object. |
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. |
TimesheetStatus |
getStatus()
Gets the current status of the timesheet: 'Submitted', 'Approved', 'Resource Manager Approved', 'Project Manager Approved', 'Active', or 'Rejected'. |
java.util.Date |
getStatusDate()
Gets the date on which the status of the timesheet was last changed. |
ObjectId |
getTimesheetPeriodObjectId()
Gets the unique ID of the timesheet period. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static Timesheet |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single Timesheet object from the database. |
static BOIterator<Timesheet> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple Timesheet objects from the database. |
Resource |
loadResource(java.lang.String[] fields)
Loads an associated Resource object from the database. |
BOIterator<ResourceHour> |
loadResourceHours(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated ResourceHour objects 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 |
---|
public Timesheet(Session session)
session
- the Sessionpublic Timesheet(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Timesheet(Session session, ObjectId timesheetPeriodObjectId, ObjectId resourceObjectId) throws BusinessObjectException
session
- the SessiontimesheetPeriodObjectId
- the first ObjectId in the keyresourceObjectId
- the second ObjectId in the key
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Timesheet(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 ObjectId createObjectId(ObjectId timesheetPeriodObjectId, ObjectId resourceObjectId) throws InvalidValueException
timesheetPeriodObjectId
- the ObjectId of the associated timesheetPeriod object.resourceObjectId
- the ObjectId of the associated resource object.
InvalidValueException
- if one of the input parameters was invalid.
java.lang.IllegalArgumentException
- if one of the input parameters was null.public ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if the ObjectId fields were not loaded.public static Timesheet load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the Timesheet 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<Timesheet> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the Timesheet 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 Resource loadResource(java.lang.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(java.lang.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 BOIterator<ResourceHour> loadResourceHours(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
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 getResourceObjectId() 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 java.lang.String getResourceId() 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 TimesheetStatus getStatus() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getLastReceivedDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsDaily() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getStatusDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getNotes() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getCreateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getLastUpdateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getCreateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getLastUpdateUser() 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 |