|
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.base.ResourceBase
com.primavera.integration.client.bo.object.Resource
public class Resource
Resources include the personnel and equipment that perform work on activities across all projects. Resources are always time-based and are generally reused between activities and/or projects. You can create a resource pool that reflects your organization's resource structure and supports the assignment of resources to activities. You can also distinguish between labor and nonlabor resources. You can create and assign resource calendars and define a resource's roles, contact information, and time-varying prices. If a resource uses Timesheets, you can also assign a login name and password to the resource.
Define a master list of resources consisting of the resources necessary to complete the projects in your enterprise structure. Then, group resources to create an easily accessible pool from which you can draw when assigning resources to a project. For each resource, set availability limits, unit prices, and a calendar to define its standard worktime and nonworktime, then allocate resources to the activities that require them. To enable grouping and rollups or your resources across the enterprise, set up resource codes and assign code values.
Resources are hierarchical and are different than expenses. While resources are time-based and generally extend across multiple activities and/or projects, expenses are one-time expenditures for non-reusable items required by activities. Expenses are not included when resources are leveled.
A resource may be specified as a primary resource when assigning to activities. An activity's primary resource is typically the resource who is responsible for coordinating an activity's work. Using Timesheets, the primary resource also updates the activity's start date, finish date, and expected end date. In addition, if an activity has any nonlabor resources, the primary resource may also be responsible for reporting the nonlabor resource's hours/units as well. With the exception of nonlabor resources, all other resources are responsible for reporting their own hours for assigned activities.
Resources may be loaded with summarized project resource spreads using the loadWithProjectResourceSpread() method. All projects must have been previously summarized using the summarizer job service. The ObjectId(s) of the project(s) are normally specified for which to load the project resource spreads. If no project ObjectIds are specified, project resource spreads are loaded for all projects to which the resource is assigned. After loading, call the getProjectResourceSpreads() method to access the spread data.
This business object supports user defined fields (UDFs) and codes. Use the UDFValue business object to assign UDFs, and the ResourceCodeAssignment business object to assign ResourceCodes.
See Also: Quick reference of Resource fields
Constructor Summary | |
---|---|
Resource(Session session)
Class constructor specifying the Session. |
|
Resource(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
Resource(Session session,
com.primavera.infr.db.PrmRowSet rowSet,
int iIndex)
Class constructor called internally after objects are retrieved from the server. |
Method Summary | |
---|---|
ObjectId |
create()
Creates this Resource object in the database. |
static ObjectId[] |
create(Session session,
Resource[] resources)
Creates multiple Resource objects in the database. |
ObjectId |
createResourceAssignment(ResourceAssignment resourceassignment)
Creates an associated ResourceAssignment object in the database. |
ObjectId[] |
createResourceAssignments(ResourceAssignment[] resourceassignments)
Creates multiple associated ResourceAssignment objects in the database. |
ObjectId |
createResourceChild(Resource resourcechild)
Creates an associated Resource object in the database. |
ObjectId[] |
createResourceChildren(Resource[] resourcechildren)
Creates multiple associated Resource objects in the database. |
ObjectId |
createResourceRate(ResourceRate resourcerate)
Creates an associated ResourceRate object in the database. |
ObjectId[] |
createResourceRates(ResourceRate[] resourcerates)
Creates multiple associated ResourceRate objects in the database. |
void |
delete()
Deletes this Resource object from the database. |
void |
delete(ObjectId replacementId)
Deletes this Resource object from the database. |
static void |
delete(Session session,
Resource[] resources)
Deletes multiple Resource objects from the database. |
static void |
delete(Session session,
Resource[] resources,
ObjectId replacementParent)
Deletes multiple resource objects in a hierarchy from the database and set the new parent of all child objects. |
static String[] |
getAllFields()
Gets all non-code fields for this business object. |
boolean |
getAutoComputeActuals()
Gets the flag that identifies whether the activity actual and remaining units, start dates and finish dates for the resource are computed automatically using the planned dates, planned units and the activity's schedule percent complete. |
boolean |
getCalculateCostFromUnits()
Gets the option to indicate that any new assignments for this resource will have its costs recalculated whenever any quantity changes occur. |
String |
getCalendarName()
Gets the name of the calendar. |
ObjectId |
getCalendarObjectId()
Gets the unique ID of the calendar assigned to the resource. |
Date |
getCreateDate()
Gets the date this resource was created. |
String |
getCreateUser()
Gets the name of the user that created this resource. |
String |
getCurrencyId()
Gets the unique currency abbreviation for the currency associated with this resource. |
String |
getCurrencyName()
Gets the name of the currency associated with this resource. |
ObjectId |
getCurrencyObjectId()
Gets the unique ID of the currency associated with this resource. |
UnitsPerTime |
getDefaultUnitsPerTime()
Gets the default units/time setting, which determines the value of the remaining units/time and planned units/time when a resource assignment is added. |
static String[] |
getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified. |
BeginDate |
getEffectiveDate()
Gets the earliest day when the resource becomes overallocated, calculated during the summarization. |
String |
getEmailAddress()
Gets the e-mail address for the resource. |
String |
getEmployeeId()
Gets the resource identifier within the organization, typically the employee number or social security number. |
static String[] |
getFilterableFields()
Gets all fields that can be filtered. |
String |
getGUID()
Gets the globally unique ID generated by the system. |
String |
getId()
Gets the short code that uniquely identifies the resource. |
IntegratedObjectType |
getIntegratedType()
Gets the flag indicating whether the resource is integrated with an Enterprise Resource Planning (ERP) system. |
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 |
getIsActive()
Gets the flag that indicates whether the resource is currently active. |
boolean |
getIsOverTimeAllowed()
Gets the flag that indicates whether the resource is allowed to log overtime hours. |
Date |
getLastUpdateDate()
Gets the date this resource was last updated. |
String |
getLastUpdateUser()
Gets the name of the user that last updated this resource. |
static String[] |
getMainFields()
Gets all fields in the main group for this business object. |
UnitsPerTime |
getMaxUnitsPerTime()
Gets the maximum work units per time this resource can perform on all their assigned activities. |
static String[] |
getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter |
String |
getName()
Gets the name of the resource. |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
String |
getOfficePhone()
Gets the office phone number for the resource. |
String |
getOtherPhone()
Gets the other phone numbers for the resource - pager, home phone, cell phone, etc. |
double |
getOvertimeFactor()
Gets the overtime factor used to compute the overtime price for the resource. |
ObjectId |
getParentObjectId()
Gets the unique ID of the parent resource of this resource in the hierarchy. |
Cost |
getPricePerUnit()
Gets the planned price per unit for the project expense. |
String |
getPrimaryRoleId()
Gets the short code that uniquely identifies the primary role for this resource. |
String |
getPrimaryRoleName()
Gets the name of the primary role for this resource. |
ObjectId |
getPrimaryRoleObjectId()
Gets the unique ID of the role that is assigned as the resource's primary role. |
ProjectResourceSpread[] |
getProjectResourceSpreads()
Gets the field containing project spread data for this resource. |
static String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
String |
getResourceNotes()
Gets the notes about the resource. |
static String[] |
getResourceSpreadFields()
Gets all spread fields that can be specified in the spreadFields parameter of loadWithResourceSpread methods for this business object. |
ResourceType |
getResourceType()
Gets the resource type: "Labor", "Nonlabor", or "Material". |
int |
getSequenceNumber()
Gets the sequence number for sorting. |
ObjectId |
getShiftObjectId()
Gets the unique ID of the shift associated with the resource. |
String |
getTimesheetApprovalManager()
Gets the resource manager assigned to approve timesheets for the resource. |
ObjectId |
getTimesheetApprovalManagerObjectId()
Gets the unique ID of the resource manager assigned to approve timesheets for the resource. |
String |
getTitle()
Gets the title of the resource. |
ObjectId |
getUnitOfMeasureObjectId()
Gets the unit of measure this material resource uses. |
String |
getUserName()
Gets the user's login name. |
ObjectId |
getUserObjectId()
Gets the unique ID of the associated user. |
boolean |
getUseTimesheets()
Gets the flag that indicates whether the resource uses timesheets. |
static String[] |
getWritableFields()
Gets all writable fields for this business object. |
static Resource |
load(Session session,
String[] fields,
ObjectId objId)
Loads a single Resource object from the database. |
static BOIterator<Resource> |
load(Session session,
String[] fields,
ObjectId[] objIds)
Loads multiple Resource objects from the database. |
BOIterator<Activity> |
loadActivities(String[] fields,
String sWhereClause,
String sOrderBy)
Load the Activity objects to which this Resource is assigned as a ResourceAssignment. |
Calendar |
loadCalendar(String[] fields)
Loads an associated Calendar object from the database. |
Currency |
loadCurrency(String[] fields)
Loads an associated Currency object from the database. |
BOIterator<Document> |
loadDocuments(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated Document objects from the database. |
Resource |
loadParentResource(String[] fields)
Loads an associated Resource object from the database. |
Role |
loadPrimaryRole(String[] fields)
Loads an associated Role object from the database. |
BOIterator<ProjectIssue> |
loadProjectIssues(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated ProjectIssue objects from the database. |
BOIterator<ProjectResource> |
loadProjectResources(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated ProjectResource objects from the database. |
BOIterator<ResourceAccess> |
loadResourceAccess(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated ResourceAccess objects from the database. |
BOIterator<ResourceAssignment> |
loadResourceAssignments(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated ResourceAssignment objects from the database. |
BOIterator<ResourceAssignment> |
loadResourceAssignmentsWithLiveSpread(String[] nonSpreadFields,
String sWhereClause,
String sOrderBy,
String[] spreadFields,
SpreadPeriodType periodType,
Date startDate,
Date endDate,
boolean bIncludeCumulative)
Loads multiple associated ResourceAssignment objects with spreads from the database. |
BOIterator<Resource> |
loadResourceChildren(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated Resource objects from the database. |
BOIterator<ResourceCodeAssignment> |
loadResourceCodeAssignments(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated ResourceCodeAssignment objects from the database. |
BOIterator<ResourceHour> |
loadResourceHours(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated ResourceHour objects from the database. |
BOIterator<ResourceRate> |
loadResourceRates(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated ResourceRate objects from the database. |
BOIterator<ResourceRole> |
loadResourceRoles(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated ResourceRole objects from the database. |
BOIterator<Risk> |
loadRisks(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated Risk objects from the database. |
static BOIterator<Resource> |
loadRootResources(Session session,
String[] fields)
Loads the root Resource objects from the database. |
Shift |
loadShift(String[] fields)
Loads an associated Shift object from the database. |
User |
loadTimesheetApprovalManager(String[] fields)
Loads an associated User object from the database. |
BOIterator<Timesheet> |
loadTimesheets(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated Timesheet objects from the database. |
BOIterator<UDFValue> |
loadUDFValues(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated UDFValue objects from the database. |
UnitOfMeasure |
loadUnitOfMeasure(String[] fields)
Loads an associated UnitOfMeasure object from the database. |
User |
loadUser(String[] fields)
Loads an associated User object from the database. |
static BOIterator<Resource> |
loadWithProjectResourceSpread(Session session,
String[] nonSpreadFields,
ObjectId[] objIds,
String[] spreadFields,
SpreadPeriodType periodType,
Date startDate,
Date endDate,
boolean bIncludeCumulative,
ObjectId[] projectObjectIds)
Loads multiple Resource objects with summarized spreads from the database. |
static Resource |
loadWithProjectResourceSpread(Session session,
String[] nonSpreadFields,
ObjectId objId,
String[] spreadFields,
SpreadPeriodType periodType,
Date startDate,
Date endDate,
boolean bIncludeCumulative,
ObjectId[] projectObjectIds)
Loads a Resource object with summarized spreads from the database. |
void |
setAutoComputeActuals(boolean b)
Sets the flag that identifies whether the activity actual and remaining units, start dates and finish dates for the resource are computed automatically using the planned dates, planned units and the activity's schedule percent complete. |
void |
setCalculateCostFromUnits(boolean b)
Sets the option to indicate that any new assignments for this resource will have its costs recalculated whenever any quantity changes occur. |
void |
setCalendarObjectId(ObjectId o)
Sets the unique ID of the calendar assigned to the resource. |
void |
setCurrencyObjectId(ObjectId o)
Sets the unique ID of the currency associated with this resource. |
void |
setDefaultUnitsPerTime(UnitsPerTime d)
Sets the default units/time setting, which determines the value of the remaining units/time and planned units/time when a resource assignment is added. |
void |
setEmailAddress(String s)
Sets the e-mail address for the resource. |
void |
setEmployeeId(String s)
Sets the resource identifier within the organization, typically the employee number or social security number. |
void |
setGUID(String s)
Sets the globally unique ID generated by the system. |
void |
setId(String s)
Sets the short code that uniquely identifies the resource. |
void |
setIntegratedType(IntegratedObjectType enm)
Sets the flag indicating whether the resource is integrated with an Enterprise Resource Planning (ERP) system. |
void |
setIsActive(boolean b)
Sets the flag that indicates whether the resource is currently active. |
void |
setIsOverTimeAllowed(boolean b)
Sets the flag that indicates whether the resource is allowed to log overtime hours. |
void |
setName(String s)
Sets the name of the resource. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setOfficePhone(String s)
Sets the office phone number for the resource. |
void |
setOtherPhone(String s)
Sets the other phone numbers for the resource - pager, home phone, cell phone, etc. |
void |
setOvertimeFactor(double d)
Sets the overtime factor used to compute the overtime price for the resource. |
void |
setParentObjectId(ObjectId o)
Sets the unique ID of the parent resource of this resource in the hierarchy. |
void |
setPrimaryRoleObjectId(ObjectId o)
Sets the unique ID of the role that is assigned as the resource's primary role. |
void |
setResourceNotes(String s)
Sets the notes about the resource. |
void |
setResourceType(ResourceType enm)
Sets the resource type: "Labor", "Nonlabor", or "Material". |
void |
setSequenceNumber(int i)
Sets the sequence number for sorting. |
void |
setShiftObjectId(ObjectId o)
Sets the unique ID of the shift associated with the resource. |
void |
setTimesheetApprovalManagerObjectId(ObjectId o)
Sets the unique ID of the resource manager assigned to approve timesheets for the resource. |
void |
setTitle(String s)
Sets the title of the resource. |
void |
setUnitOfMeasureObjectId(ObjectId o)
Sets the unit of measure this material resource uses. |
void |
setUserObjectId(ObjectId o)
Sets the unique ID of the associated user. |
void |
setUseTimesheets(boolean b)
Sets the flag that indicates whether the resource uses timesheets. |
String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this Resource object in the database. |
static void |
update(Session session,
Resource[] resources)
Updates multiple Resource objects in the database. |
Methods inherited from class com.primavera.integration.client.bo.BusinessObject |
---|
equals, hashCode, isNull, setNull |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Resource(Session session)
session
- the Sessionpublic Resource(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Resource(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 ObjectId createResourceAssignment(ResourceAssignment resourceassignment) throws ServerException, NetworkException, BusinessObjectException
resourceassignment
- ResourceAssignment object to create
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[] createResourceAssignments(ResourceAssignment[] resourceassignments) throws ServerException, NetworkException, BusinessObjectException
resourceassignments
- array of ResourceAssignment objects to create
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<ResourceAssignment> loadResourceAssignments(String[] fields, String sWhereClause, 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 BOIterator<ResourceAssignment> loadResourceAssignmentsWithLiveSpread(String[] nonSpreadFields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
nonSpreadFields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clausespreadFields
- the fields to include in the spread objectperiodType
- the period of the spread data (hour, day, etc.)startDate
- the start date of the spreadendDate
- the end date of the spreadbIncludeCumulative
- indicates whether to include cumulative spread data
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 loadParentResource(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 createResourceChild(Resource resourcechild) throws ServerException, NetworkException, BusinessObjectException
resourcechild
- ResourceChild object to create
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[] createResourceChildren(Resource[] resourcechildren) throws ServerException, NetworkException, BusinessObjectException
resourcechildren
- array of ResourceChild objects to create
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<Resource> loadResourceChildren(String[] fields, String sWhereClause, 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 static BOIterator<Resource> loadRootResources(Session session, String[] fields) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- 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 Role loadPrimaryRole(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 Currency loadCurrency(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 Calendar loadCalendar(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 User loadUser(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 Shift loadShift(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<ResourceRole> loadResourceRoles(String[] fields, String sWhereClause, 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 BOIterator<ResourceAccess> loadResourceAccess(String[] fields, String sWhereClause, 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 User loadTimesheetApprovalManager(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<ProjectIssue> loadProjectIssues(String[] fields, String sWhereClause, 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 BOIterator<ResourceHour> loadResourceHours(String[] fields, String sWhereClause, 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 createResourceRate(ResourceRate resourcerate) throws ServerException, NetworkException, BusinessObjectException
resourcerate
- ResourceRate object to create
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[] createResourceRates(ResourceRate[] resourcerates) throws ServerException, NetworkException, BusinessObjectException
resourcerates
- array of ResourceRate objects to create
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<ResourceRate> loadResourceRates(String[] fields, String sWhereClause, 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 BOIterator<Timesheet> loadTimesheets(String[] fields, String sWhereClause, 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 UnitOfMeasure loadUnitOfMeasure(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<Document> loadDocuments(String[] fields, String sWhereClause, 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 BOIterator<ProjectResource> loadProjectResources(String[] fields, String sWhereClause, 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 BOIterator<ResourceCodeAssignment> loadResourceCodeAssignments(String[] fields, String sWhereClause, 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 BOIterator<Risk> loadRisks(String[] fields, String sWhereClause, 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 BOIterator<UDFValue> loadUDFValues(String[] fields, String sWhereClause, 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 BOIterator<Activity> loadActivities(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
loadActivities
in class com.primavera.integration.client.bo.base.ResourceBase
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order by clause
ServerException
NetworkException
BusinessObjectException
public ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setObjectId(ObjectId o) throws BusinessObjectException
setObjectId
in class BusinessObject
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getParentObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setParentObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getSequenceNumber() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setSequenceNumber(int i) throws BusinessObjectException
i
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getPrimaryRoleObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setPrimaryRoleObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getCalendarObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setCalendarObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getCurrencyObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setCurrencyObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getUserObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setUserObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getShiftObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setShiftObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getTimesheetApprovalManagerObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setTimesheetApprovalManagerObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getUnitOfMeasureObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setUnitOfMeasureObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setId(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setName(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getTitle() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setTitle(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsActive() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setIsActive(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getAutoComputeActuals() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setAutoComputeActuals(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsOverTimeAllowed() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setIsOverTimeAllowed(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getUseTimesheets() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setUseTimesheets(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ResourceType getResourceType() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setResourceType(ResourceType enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getCalculateCostFromUnits() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setCalculateCostFromUnits(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getEmailAddress() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setEmailAddress(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getEmployeeId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setEmployeeId(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getOfficePhone() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setOfficePhone(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getOtherPhone() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setOtherPhone(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic UnitsPerTime getDefaultUnitsPerTime() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDefaultUnitsPerTime(UnitsPerTime d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getOvertimeFactor() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setOvertimeFactor(double d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getGUID() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setGUID(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getResourceNotes() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setResourceNotes(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic IntegratedObjectType getIntegratedType() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setIntegratedType(IntegratedObjectType enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getPrimaryRoleName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getPrimaryRoleId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getUserName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getCalendarName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getCurrencyId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getCurrencyName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getTimesheetApprovalManager() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic UnitsPerTime getMaxUnitsPerTime() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic BeginDate getEffectiveDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Cost getPricePerUnit() 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 ProjectResourceSpread[] getProjectResourceSpreads() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static String[] getRequiredCreateFields()
public static String[] getFilterableFields()
public static String[] getInternalDefaultLoadFields()
public static String[] getAllFields()
public static String[] getInternalAllFields()
public static Set<String> getInternalAllFieldsSet()
public static String[] getMainFields()
public static String[] getResourceSpreadFields()
public static String[] getWritableFields()
public static String[] getDefaultXMLExportFields()
public static String[] getMinimumXMLExportFields()
public String toString()
toString
in class Object
public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
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 ObjectId[] create(Session session, Resource[] resources) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectresources
- array of Resource objects to create
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 Resource load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the Resource 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<Resource> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the Resource 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 static Resource loadWithProjectResourceSpread(Session session, String[] nonSpreadFields, ObjectId objId, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative, ObjectId[] projectObjectIds) throws ServerException, NetworkException, BusinessObjectException
nonSpreadFields
- fields to loadobjId
- unique ID of the Resource objectspreadFields
- the fields to include in the spread objectperiodType
- the period of the spread data (hour, day, etc.)startDate
- the start date of the spreadendDate
- the end date of the spreadbIncludeCumulative
- indicates whether to include cumulative spread dataprojectObjectIds
- object ids of the Project 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 static BOIterator<Resource> loadWithProjectResourceSpread(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative, ObjectId[] projectObjectIds) throws ServerException, NetworkException, BusinessObjectException
nonSpreadFields
- fields to loadobjIds
- object ids of the Resource objectsspreadFields
- the fields to include in the spread objectperiodType
- the period of the spread data (hour, day, etc.)startDate
- the start date of the spreadendDate
- the end date of the spreadbIncludeCumulative
- indicates whether to include cumulative spread dataprojectObjectIds
- object ids of the Project 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 void update() throws ServerException, NetworkException, BusinessObjectException
update
in class com.primavera.integration.client.BOBase
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 void update(Session session, Resource[] resources) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectresources
- array of Resource objects to update
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 void delete() throws ServerException, NetworkException, BusinessObjectException
delete
in class com.primavera.integration.client.BOBase
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 void delete(ObjectId replacementId) throws ServerException, NetworkException, BusinessObjectException
delete
in class com.primavera.integration.client.BOBase
replacementId
- unique ID of the new parent for all current child 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 static void delete(Session session, Resource[] resources) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectresources
- array of Resource objects to delete
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 void delete(Session session, Resource[] resources, ObjectId replacementParent) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectresources
- array of Resource objects to deletereplacementParent
- replacement parent 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 objects
|
Primavera Integration API 8.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |