|
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.ProjectResourceQuantity
public class ProjectResourceQuantity
The ProjectResourceQuantity object provides access to resource allocation hours per week for resources assigned to a project at the Project or WBS level. Usually there is one ProjectResourceQuantity object per week, and it corresponds to a record in the wbsrsrc_qty table. However, when a week contains days from more than one month, two ProjectResourceQuantity objects (and so, two records) will exist based on the two week fragments. They both have the same WeekStartDate but their MonthStartDate and week fragment data are different: The first ProjectResourceQuantity object holds data for the first week fragment, and its MonthStartDate has the same month as the WeekStartDate. The second ProjectResourceQuantity object holds data for the second week fragment, and its MonthStartDate is that of the next month.
See Also: Quick reference of ProjectResourceQuantity fields
Constructor Summary | |
---|---|
ProjectResourceQuantity(Session session)
Class constructor specifying the Session. |
|
ProjectResourceQuantity(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
ProjectResourceQuantity(Session session,
ObjectId projectResourceObjectId,
java.util.Date weekStartDate,
java.util.Date monthStartDate)
Class constructor specifying the Session and the individual components of the multi-part key: ProjectResourceObjectId, WeekStartDate, and MonthStartDate. |
|
ProjectResourceQuantity(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 ProjectResourceQuantity object in the database. |
static ObjectId[] |
create(Session session,
ProjectResourceQuantity[] projectresourcequantities)
Creates multiple ProjectResourceQuantity objects in the database. |
static ObjectId |
createObjectId(ObjectId projectResourceObjectId,
java.util.Date weekStartDate,
java.util.Date monthStartDate)
Creates a multi-part ObjectId from two individual ObjectIds. |
void |
delete()
Deletes this ProjectResourceQuantity object from the database. |
static void |
delete(Session session,
ProjectResourceQuantity[] projectresourcequantities)
Deletes multiple ProjectResourceQuantity 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 quantity was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this project resource quantity. |
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. |
ObjectId |
getFinancialPeriod1ObjectId()
Gets the unique ID of the associated first financial period for this project resource quantity. |
Unit |
getFinancialPeriod1Quantity()
Gets the value that represents the resource allocation hours for the first financial period for this project resource quantity. |
ObjectId |
getFinancialPeriod2ObjectId()
Gets the unique ID of the associated second financial period for this project resource quantity. |
Unit |
getFinancialPeriod2Quantity()
Gets the value that represents the resource allocation hours for the second financial period for this project resource quantity. |
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 quantity was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this project resource quantity. |
static java.lang.String[] |
getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter |
java.util.Date |
getMonthStartDate()
Gets the date value that represents the first day of the month. |
ObjectId |
getObjectId()
Gets the ObjectId for this object. |
ObjectId |
getProjectObjectId()
Gets the unique ID of the associated project. |
ObjectId |
getProjectResourceObjectId()
Gets the unique ID of the associated project resource. |
Unit |
getQuantity()
Gets the value that represents the resource allocation hours per week for this project resource quantity. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
ObjectId |
getResourceObjectId()
Gets the unique ID of the associated resource. |
ObjectId |
getRoleObjectId()
Gets the unique ID of the associated role. |
ObjectId |
getWBSObjectId()
Gets the unique ID of the associated WBS. |
java.util.Date |
getWeekStartDate()
Gets the date value that represents the first day of the week. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static ProjectResourceQuantity |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single ProjectResourceQuantity object from the database. |
static BOIterator<ProjectResourceQuantity> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple ProjectResourceQuantity objects from the database. |
Project |
loadProject(java.lang.String[] fields)
Loads an associated Project object from the database. |
ProjectResource |
loadProjectResource(java.lang.String[] fields)
Loads an associated ProjectResource object 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 |
setFinancialPeriod1Quantity(Unit u)
Sets the value that represents the resource allocation hours for the first financial period for this project resource quantity. |
void |
setFinancialPeriod2Quantity(Unit u)
Sets the value that represents the resource allocation hours for the second financial period for this project resource quantity. |
void |
setMonthStartDate(java.util.Date d)
Sets the date value that represents the first day of the month. |
void |
setProjectResourceObjectId(ObjectId o)
Sets the unique ID of the associated project resource. |
void |
setQuantity(Unit u)
Sets the value that represents the resource allocation hours per week for this project resource quantity. |
void |
setWeekStartDate(java.util.Date d)
Sets the date value that represents the first day of the week. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this ProjectResourceQuantity object in the database. |
static void |
update(Session session,
ProjectResourceQuantity[] projectresourcequantities)
Updates multiple ProjectResourceQuantity objects in the database. |
Methods inherited from class com.primavera.integration.client.bo.BusinessObject |
---|
equals, hashCode, isNull, setNull, setObjectId |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ProjectResourceQuantity(Session session)
session
- the Sessionpublic ProjectResourceQuantity(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ProjectResourceQuantity(Session session, ObjectId projectResourceObjectId, java.util.Date weekStartDate, java.util.Date monthStartDate) throws BusinessObjectException
session
- the SessionprojectResourceObjectId
- the first ObjectId in the keyweekStartDate
- the second ObjectId in the keymonthStartDate
- the third ObjectId in the key
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ProjectResourceQuantity(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
session
- the SessionrowSet
- the PrmRowSet retrieved from the serveriIndex
- the row index in the PrmRowSet associated with this business object
BusinessObjectException
- if a problem occurred in the client-side business objectsMethod Detail |
---|
public static ObjectId createObjectId(ObjectId projectResourceObjectId, java.util.Date weekStartDate, java.util.Date monthStartDate) throws InvalidValueException
projectResourceObjectId
- the ObjectId of the associated projectResource object.weekStartDate
- the ObjectId of the associated weekS object.
InvalidValueException
- if one of the input parameters was invalid.
java.lang.IllegalArgumentException
- if one of the input parameters was null.public ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if the ObjectId fields were not loaded.public 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, ProjectResourceQuantity[] projectresourcequantities) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectresourcequantities
- array of ProjectResourceQuantity 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 ProjectResourceQuantity load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ProjectResourceQuantity 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<ProjectResourceQuantity> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ProjectResourceQuantity 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, ProjectResourceQuantity[] projectresourcequantities) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectresourcequantities
- array of ProjectResourceQuantity 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, ProjectResourceQuantity[] projectresourcequantities) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectresourcequantities
- array of ProjectResourceQuantity 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 ProjectResource loadProjectResource(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 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 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 ObjectId getProjectResourceObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setProjectResourceObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getWeekStartDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setWeekStartDate(java.util.Date d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getMonthStartDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setMonthStartDate(java.util.Date d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Unit getQuantity() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setQuantity(Unit u) throws BusinessObjectException
u
- 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 ObjectId getResourceObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getFinancialPeriod1ObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getFinancialPeriod2ObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Unit getFinancialPeriod1Quantity() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setFinancialPeriod1Quantity(Unit u) throws BusinessObjectException
u
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Unit getFinancialPeriod2Quantity() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setFinancialPeriod2Quantity(Unit u) throws BusinessObjectException
u
- 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 boolean getCommittedFlag() 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 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 |