Primavera Integration API 7.0

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

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

public class TimesheetDelegate
extends BusinessObject

Timesheet delegates provide resource and project managers the ability to assign a user to process their timesheets as a delegate. After selecting a delegate for their resources or projects, the resource or project manager can activate and disable the delegate's approval rights at any time. Timesheet delegates for resource managers can review timesheets for resources to whom the resource manager has been assigned as a timesheet approval manager. Timesheet delegates for a project manager can review timesheets for resources who are assigned to activities within the project(s) for which the project manager has been granted approval rights. A project manager can delegate approval rights to different users for each project.

TimesheetDelegates are readonly.

See Also:   Quick reference of TimesheetDelegate fields


Constructor Summary
TimesheetDelegate(Session session)
          Class constructor specifying the Session.
TimesheetDelegate(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
TimesheetDelegate(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)
          Class constructor called internally after objects are retrieved from the server.
 
Method Summary
 boolean getActiveFlag()
          Gets the flag indicating whether this delegate is active.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 java.lang.String getApproverUserName()
          Gets the approver user's login name.
 ObjectId getApproverUserObjectId()
          Gets the unique ID of the approver user.
 java.util.Date getCreateDate()
          Gets the date this timesheet delegate was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this timesheet delegate.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
 java.lang.String getDelegateUserEmailAddress()
          Gets the delegate user's email address.
 java.lang.String getDelegateUserName()
          Gets the delegate user's login name.
 ObjectId getDelegateUserObjectId()
          Gets the unique ID of the delegate user.
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.
 java.util.Date getLastUpdateDate()
          Gets the date this timesheet delegate was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this timesheet delegate.
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.
 ObjectId getProjectObjectId()
          Gets the unique ID of the associated project.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static TimesheetDelegate load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single TimesheetDelegate object from the database.
static BOIterator<TimesheetDelegate> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple TimesheetDelegate objects from the database.
 User loadApproverUser(java.lang.String[] fields)
          Loads an associated User object from the database.
 User loadDelegateUser(java.lang.String[] fields)
          Loads an associated User object from the database.
 Project loadProject(java.lang.String[] fields)
          Loads an associated Project 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

TimesheetDelegate

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

TimesheetDelegate

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

TimesheetDelegate

public TimesheetDelegate(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 TimesheetDelegate load(Session session,
                                     java.lang.String[] fields,
                                     ObjectId objId)
                              throws ServerException,
                                     NetworkException,
                                     BusinessObjectException
Loads a single TimesheetDelegate object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the TimesheetDelegate object
Returns:
TimesheetDelegate the TimesheetDelegate 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<TimesheetDelegate> load(Session session,
                                                 java.lang.String[] fields,
                                                 ObjectId[] objIds)
                                          throws ServerException,
                                                 NetworkException,
                                                 BusinessObjectException
Loads multiple TimesheetDelegate objects from the database.

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

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

loadApproverUser

public User loadApproverUser(java.lang.String[] fields)
                      throws ServerException,
                             NetworkException,
                             BusinessObjectException
Loads an associated User object from the database.

Parameters:
fields - fields to load
Returns:
User the User 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

loadDelegateUser

public User loadDelegateUser(java.lang.String[] fields)
                      throws ServerException,
                             NetworkException,
                             BusinessObjectException
Loads an associated User object from the database.

Parameters:
fields - fields to load
Returns:
User the User 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

getApproverUserObjectId

public ObjectId getApproverUserObjectId()
                                 throws BusinessObjectException
Gets the unique ID of the approver user. 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 ApproverUserObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getDelegateUserObjectId

public ObjectId getDelegateUserObjectId()
                                 throws BusinessObjectException
Gets the unique ID of the delegate user. 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 DelegateUserObjectId
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

getActiveFlag

public boolean getActiveFlag()
                      throws BusinessObjectException
Gets the flag indicating whether this delegate is active.

Returns:
the value in the field ActiveFlag
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 delegate was created.

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

Returns:
the value in the field CreateUser
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 delegate was last updated.

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

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

getDelegateUserName

public java.lang.String getDelegateUserName()
                                     throws BusinessObjectException
Gets the delegate user's login name.

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

getDelegateUserEmailAddress

public java.lang.String getDelegateUserEmailAddress()
                                             throws BusinessObjectException
Gets the delegate user's email address.

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

getApproverUserName

public java.lang.String getApproverUserName()
                                     throws BusinessObjectException
Gets the approver user's login name.

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