Primavera Integration API 7.0

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

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.Timesheet

public class Timesheet
extends BusinessObject

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

Timesheet

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

Timesheet

public Timesheet(Session session,
                 ObjectId objId)
          throws BusinessObjectException
Class constructor specifying the Session and ObjectId of the object. For this particular object, the ObjectId is multi-part, created from the TimesheetPeriodObjectId and ResourceObjectId field values. If you do not have the multi-part ObjectId already, it would be simpler to instead use the constructor that has multiple key parameters.

Parameters:
session - the Session
objId - the ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

Timesheet

public Timesheet(Session session,
                 ObjectId timesheetPeriodObjectId,
                 ObjectId resourceObjectId)
          throws BusinessObjectException
Class constructor specifying the Session and the individual components of the multi-part key: TimesheetPeriodObjectId and ResourceObjectId.

Parameters:
session - the Session
timesheetPeriodObjectId - the first ObjectId in the key
resourceObjectId - the second ObjectId in the key
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

Timesheet

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

createObjectId

public static ObjectId createObjectId(ObjectId timesheetPeriodObjectId,
                                      ObjectId resourceObjectId)
                               throws InvalidValueException
Creates a multi-part ObjectId from two individual ObjectIds.

Parameters:
timesheetPeriodObjectId - the ObjectId of the associated timesheetPeriod object.
resourceObjectId - the ObjectId of the associated resource object.
Returns:
ObjectId the multi-part ObjectId
Throws:
InvalidValueException - if one of the input parameters was invalid.
java.lang.IllegalArgumentException - if one of the input parameters was null.

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the ObjectId for this object. The ObjectId field serves as the primary key for the associated table in the database. For this object, the ObjectId is multi-part, consisting internally of the TimesheetPeriodObjectId and ResourceObjectId fields.

Overrides:
getObjectId in class BusinessObject
Returns:
ObjectId the multi-part ObjectId of this object
Throws:
BusinessObjectException - if the ObjectId fields were not loaded.

load

public static Timesheet load(Session session,
                             java.lang.String[] fields,
                             ObjectId objId)
                      throws ServerException,
                             NetworkException,
                             BusinessObjectException
Loads a single Timesheet object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the Timesheet object
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

load

public static BOIterator<Timesheet> load(Session session,
                                         java.lang.String[] fields,
                                         ObjectId[] objIds)
                                  throws ServerException,
                                         NetworkException,
                                         BusinessObjectException
Loads multiple Timesheet objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the Timesheet 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

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

loadResourceHours

public BOIterator<ResourceHour> loadResourceHours(java.lang.String[] fields,
                                                  java.lang.String sWhereClause,
                                                  java.lang.String sOrderBy)
                                           throws ServerException,
                                                  NetworkException,
                                                  BusinessObjectException
Loads multiple associated ResourceHour objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
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

getResourceObjectId

public ObjectId getResourceObjectId()
                             throws BusinessObjectException
Gets the unique ID of the associated resource. 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. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Returns:
the value in the field ResourceId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getTimesheetPeriodObjectId

public ObjectId getTimesheetPeriodObjectId()
                                    throws BusinessObjectException
Gets the unique ID of the timesheet period. 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

getStatus

public TimesheetStatus getStatus()
                          throws BusinessObjectException
Gets the current status of the timesheet: '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

getLastReceivedDate

public java.util.Date getLastReceivedDate()
                                   throws BusinessObjectException
Gets the last date on which the timesheet was submitted by the resource.

Returns:
the value in the field LastReceivedDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getIsDaily

public boolean getIsDaily()
                   throws BusinessObjectException
Gets the flag that identifies whether timesheet users enter hours daily or by entire timesheet reporting period.

Returns:
the value in the field IsDaily
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getStatusDate

public java.util.Date getStatusDate()
                             throws BusinessObjectException
Gets the date on which the status of the timesheet was last changed.

Returns:
the value in the field StatusDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getNotes

public java.lang.String getNotes()
                          throws BusinessObjectException
Gets the notes associated with the timesheet. 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 Notes
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this timesheet 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 timesheet 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 timesheet.

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 timesheet.

Returns:
the value in the field LastUpdateUser
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.