|
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.ProjectResource
public class ProjectResource
Primavera's resource planning feature allows you to do high-level project planning for future project or project that does not require resource assignments at the activity level. The resource planning feature allows you to allocate and manage resources at the project and WBS levels. If the LifeOfProjectFlag is true, the resource assignment is for the duration of the project, and so, if the project dates are pushed out, the resource assignment dates are pushed as well.
If the LifeOfProjectFlag is false, the dates on the ProjectResource will be calculated from the dates on the child ProjectResourceQuantity objects.
See Also: Quick reference of ProjectResource fields
Constructor Summary | |
---|---|
ProjectResource(Session session)
Class constructor specifying the Session. |
|
ProjectResource(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
ProjectResource(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 ProjectResource object in the database. |
static ObjectId[] |
create(Session session,
ProjectResource[] projectresources)
Creates multiple ProjectResource objects in the database. |
void |
delete()
Deletes this ProjectResource object from the database. |
static void |
delete(Session session,
ProjectResource[] projectresources)
Deletes multiple ProjectResource objects from the database. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
boolean |
getCommittedFlag()
Gets the Boolean value that determines whether a resource is committed, and so, the resource assignment is stable and unlikely to change. |
java.util.Date |
getCreateDate()
Gets the date this project resource was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this project resource. |
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. |
java.util.Date |
getFinishDate()
Gets the finish date of the assignment. |
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 |
getIsBaseline()
Gets the boolean value indicating if this business object is related to a Project or Baseline. |
java.util.Date |
getLastUpdateDate()
Gets the date this project resource was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this project resource. |
boolean |
getLifeOfProjectFlag()
Gets the Boolean value that determines whether a resource that is assigned to a project at Project or WBS level, has that assignment for the duration of the project. |
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. |
java.lang.String |
getProjectId()
Gets the short code that uniquely identifies the associated project. |
ObjectId |
getProjectObjectId()
Gets the unique ID of the associated project. |
java.lang.String |
getProjectResourceCategoryName()
Gets the name of the associated project resource category. |
ObjectId |
getProjectResourceCategoryObjectId()
Gets the unique ID of the associated project resource category. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
java.lang.String |
getResourceName()
Gets the name of the associated resource. |
ObjectId |
getResourceObjectId()
Gets the unique ID of the associated resource. |
com.primavera.integration.common.value.ResourceRequest |
getResourceRequest()
Gets the resource request used as a search template to search for a qualified resource. |
java.lang.String |
getRoleName()
Gets the name of the associated role. |
ObjectId |
getRoleObjectId()
Gets the unique ID of the associated role. |
java.util.Date |
getStartDate()
Gets the start date of the assignment. |
ProjectStatus |
getStatus()
Gets the project or WBS status: 'Planned', 'Active', 'Inactive', 'What-If', or 'Requested'. |
java.lang.String |
getWBSCode()
Gets the short code assigned to the associated WBS element for identification. |
ObjectId |
getWBSObjectId()
Gets the unique ID of the associated WBS. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static ProjectResource |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single ProjectResource object from the database. |
static BOIterator<ProjectResource> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple ProjectResource objects from the database. |
Project |
loadProject(java.lang.String[] fields)
Loads an associated Project object from the database. |
ProjectResourceCategory |
loadProjectResourceCategory(java.lang.String[] fields)
Loads an associated ProjectResourceCategory object from the database. |
BOIterator<ProjectResourceQuantity> |
loadProjectResourceQuantities(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated ProjectResourceQuantity objects from the database. |
Resource |
loadResource(java.lang.String[] fields)
Loads an associated Resource object from the database. |
WBS |
loadWBS(java.lang.String[] fields)
Loads an associated WBS object from the database. |
void |
setCommittedFlag(boolean b)
Sets the Boolean value that determines whether a resource is committed, and so, the resource assignment is stable and unlikely to change. |
void |
setLifeOfProjectFlag(boolean b)
Sets the Boolean value that determines whether a resource that is assigned to a project at Project or WBS level, has that assignment for the duration of the project. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setProjectObjectId(ObjectId o)
Sets the unique ID of the associated project. |
void |
setProjectResourceCategoryObjectId(ObjectId o)
Sets the unique ID of the associated project resource category. |
void |
setResourceObjectId(ObjectId o)
Sets the unique ID of the associated resource. |
void |
setResourceRequest(com.primavera.integration.common.value.ResourceRequest r)
Sets the resource request used as a search template to search for a qualified resource. |
void |
setRoleObjectId(ObjectId o)
Sets the unique ID of the associated role. |
void |
setWBSObjectId(ObjectId o)
Sets the unique ID of the associated WBS. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this ProjectResource object in the database. |
static void |
update(Session session,
ProjectResource[] projectresources)
Updates multiple ProjectResource 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 ProjectResource(Session session)
session
- the Sessionpublic ProjectResource(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ProjectResource(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 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, ProjectResource[] projectresources) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectresources
- array of ProjectResource 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 ProjectResource load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ProjectResource 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<ProjectResource> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ProjectResource 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 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, ProjectResource[] projectresources) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectresources
- array of ProjectResource 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 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 delete(Session session, ProjectResource[] projectresources) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectresources
- array of ProjectResource 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 Project loadProject(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 WBS loadWBS(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 ProjectResourceCategory loadProjectResourceCategory(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 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 BOIterator<ProjectResourceQuantity> loadProjectResourceQuantities(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 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 getProjectResourceCategoryObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setProjectResourceCategoryObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getProjectObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setProjectObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getProjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getWBSObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setWBSObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getWBSCode() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getResourceObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setResourceObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getRoleObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setRoleObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getRoleName() 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 getProjectResourceCategoryName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ProjectStatus getStatus() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getStartDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getFinishDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getCommittedFlag() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setCommittedFlag(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getLifeOfProjectFlag() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setLifeOfProjectFlag(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic com.primavera.integration.common.value.ResourceRequest getResourceRequest() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setResourceRequest(com.primavera.integration.common.value.ResourceRequest r) throws BusinessObjectException
r
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsBaseline() 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[] getRequiredCreateFields()
public 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 |