|
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.ActivityPeriodActual
public class ActivityPeriodActual
Activity period actuals represent the actual values on an activity during a financial period.
The following rules apply to activity period actuals:
Note that this business object has a multi-part object ID, which is a combination of its financial period object ID and its activity object ID. Use the method createObjectId() to create the multi-part object ID from the individual IDs.
See Also: Quick reference of ActivityPeriodActual fields
Constructor Summary | |
---|---|
ActivityPeriodActual(Session session)
Class constructor specifying the Session. |
|
ActivityPeriodActual(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
ActivityPeriodActual(Session session,
ObjectId financialPeriodObjectId,
ObjectId activityObjectId)
Class constructor specifying the Session and the individual components of the multi-part key: FinancialPeriodObjectId and ActivityObjectId. |
|
ActivityPeriodActual(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 ActivityPeriodActual object in the database. |
static ObjectId[] |
create(Session session,
ActivityPeriodActual[] activityperiodactuals)
Creates multiple ActivityPeriodActual objects in the database. |
static ObjectId |
createObjectId(ObjectId financialPeriodObjectId,
ObjectId activityObjectId)
Creates a multi-part ObjectId from two individual ObjectIds. |
void |
delete()
Deletes this ActivityPeriodActual object from the database. |
static void |
delete(Session session,
ActivityPeriodActual[] activityperiodactuals)
Deletes multiple ActivityPeriodActual objects from the database. |
ObjectId |
getActivityObjectId()
Gets the unique ID of the associated activity. |
Cost |
getActualExpenseCost()
Gets the actual expense cost on this activity during a financial period. |
Cost |
getActualLaborCost()
Gets the actual labor cost on this activity during a financial period. |
Unit |
getActualLaborUnits()
Gets the actual labor units on this activity during a financial period. |
Cost |
getActualMaterialCost()
Gets the actual material cost on this activity during a financial period. |
Cost |
getActualNonLaborCost()
Gets the actual nonlabor cost on this activity during a financial period. |
Unit |
getActualNonLaborUnits()
Gets the actual nonlabor units on this activity during a financial period. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
java.util.Date |
getCreateDate()
Gets the date this activity period actual was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this activity period actual. |
static java.lang.String[] |
getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified. |
Cost |
getEarnedValueCost()
Gets the earned value cost on this activity during a financial period. |
Unit |
getEarnedValueLaborUnits()
Gets the earned value labor units on this activity during a financial period. |
static java.lang.String[] |
getFilterableFields()
Gets all fields that can be filtered. |
ObjectId |
getFinancialPeriodObjectId()
Gets the unique ID of the associated financial period. |
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 activity period actual was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this activity period actual. |
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 ObjectId for this object. |
Cost |
getPlannedValueCost()
Gets the planned value cost on this activity during a financial period. |
Unit |
getPlannedValueLaborUnits()
Gets the planned value labor units on this activity during a financial period. |
ObjectId |
getProjectObjectId()
Gets the unique ID of the associated project. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
ObjectId |
getWBSObjectId()
Gets the unique ID of the WBS for the activity. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static ActivityPeriodActual |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single ActivityPeriodActual object from the database. |
static BOIterator<ActivityPeriodActual> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple ActivityPeriodActual objects from the database. |
Activity |
loadActivity(java.lang.String[] fields)
Loads an associated Activity object from the database. |
FinancialPeriod |
loadFinancialPeriod(java.lang.String[] fields)
Loads an associated FinancialPeriod object from the database. |
Project |
loadProject(java.lang.String[] fields)
Loads an associated Project object from the database. |
void |
setActivityObjectId(ObjectId o)
Sets the unique ID of the associated activity. |
void |
setActualExpenseCost(Cost c)
Sets the actual expense cost on this activity during a financial period. |
void |
setActualLaborCost(Cost c)
Sets the actual labor cost on this activity during a financial period. |
void |
setActualLaborUnits(Unit u)
Sets the actual labor units on this activity during a financial period. |
void |
setActualNonLaborCost(Cost c)
Sets the actual nonlabor cost on this activity during a financial period. |
void |
setActualNonLaborUnits(Unit u)
Sets the actual nonlabor units on this activity during a financial period. |
void |
setEarnedValueCost(Cost c)
Sets the earned value cost on this activity during a financial period. |
void |
setEarnedValueLaborUnits(Unit u)
Sets the earned value labor units on this activity during a financial period. |
void |
setFinancialPeriodObjectId(ObjectId o)
Sets the unique ID of the associated financial period. |
void |
setPlannedValueCost(Cost c)
Sets the planned value cost on this activity during a financial period. |
void |
setPlannedValueLaborUnits(Unit u)
Sets the planned value labor units on this activity during a financial period. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this ActivityPeriodActual object in the database. |
static void |
update(Session session,
ActivityPeriodActual[] activityperiodactuals)
Updates multiple ActivityPeriodActual 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 ActivityPeriodActual(Session session)
session
- the Sessionpublic ActivityPeriodActual(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ActivityPeriodActual(Session session, ObjectId financialPeriodObjectId, ObjectId activityObjectId) throws BusinessObjectException
session
- the SessionfinancialPeriodObjectId
- the first ObjectId in the keyactivityObjectId
- the second ObjectId in the key
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ActivityPeriodActual(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 financialPeriodObjectId, ObjectId activityObjectId) throws InvalidValueException
financialPeriodObjectId
- the ObjectId of the associated financialPeriod object.activityObjectId
- the ObjectId of the associated activity 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, ActivityPeriodActual[] activityperiodactuals) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectactivityperiodactuals
- array of ActivityPeriodActual 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 ActivityPeriodActual load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ActivityPeriodActual 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<ActivityPeriodActual> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ActivityPeriodActual 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, ActivityPeriodActual[] activityperiodactuals) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectactivityperiodactuals
- array of ActivityPeriodActual 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, ActivityPeriodActual[] activityperiodactuals) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectactivityperiodactuals
- array of ActivityPeriodActual 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 FinancialPeriod loadFinancialPeriod(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 Activity loadActivity(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 ObjectId getFinancialPeriodObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setFinancialPeriodObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getActivityObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setActivityObjectId(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 ObjectId getWBSObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Unit getActualLaborUnits() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setActualLaborUnits(Unit u) throws BusinessObjectException
u
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Cost getActualLaborCost() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setActualLaborCost(Cost c) throws BusinessObjectException
c
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Unit getActualNonLaborUnits() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setActualNonLaborUnits(Unit u) throws BusinessObjectException
u
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Cost getActualNonLaborCost() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setActualNonLaborCost(Cost c) throws BusinessObjectException
c
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Cost getActualMaterialCost() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Cost getActualExpenseCost() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setActualExpenseCost(Cost c) throws BusinessObjectException
c
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Cost getEarnedValueCost() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setEarnedValueCost(Cost c) throws BusinessObjectException
c
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Unit getEarnedValueLaborUnits() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setEarnedValueLaborUnits(Unit u) throws BusinessObjectException
u
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Cost getPlannedValueCost() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setPlannedValueCost(Cost c) throws BusinessObjectException
c
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Unit getPlannedValueLaborUnits() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setPlannedValueLaborUnits(Unit u) throws BusinessObjectException
u
- the value to set this field to
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 boolean getIsBaseline() 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 |