Package com.primavera.integration.client.bo.object

Class ActivityPeriodActual

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.ActivityPeriodActual
public class ActivityPeriodActual extends BusinessObject

Activity period actuals represent the actual values on an activity during a financial period.

The following rules apply to activity period actuals:

  • They can be tracked only for in-progress or completed activities.
  • Negative values are allowed.
  • If both units and costs are simultaneously updated on a period actual instance, units are the driving value.
  • There is no relation between the units and costs on a period actual instance
  • They must have at least one non-zero field value for a corresponding database record to exist
  • Costs can be calculated only when a project default price per unit is defined.
  • Values for a particular resource type (labor, nonlabor, material) can be tracked at the activity level only if the activity has no resource assignments of the same type. If resource assignments exist, activity period actuals are derived from those assignments and cannot be edited.
  • If assignments exist, activity period actual values (labor, non labor, material) are calculated from resource assignments of the corresponding type.
  • For material resources, only ActualMaterialCost can be tracked.

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 Details

    • ActivityPeriodActual

      public ActivityPeriodActual(Session session)
      Class constructor specifying the Session. This constructor is most commonly used when create() is intended to be called on this object.
      Parameters:
      session - the Session

    • ActivityPeriodActual

      public ActivityPeriodActual(Session session, ObjectId objId) throws BusinessObjectException
      Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() is intended to be called on this object. For this particular object, the ObjectId is multi-part, created from the FinancialPeriodObjectId and ActivityObjectId field values. If you do not have the multi-part ObjectId already, it would be simpler to instead use the constructor that has multiple key parameters.
      Parameters:
      session - the Session
      objId - the ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • ActivityPeriodActual

      public ActivityPeriodActual(Session session, ObjectId financialPeriodObjectId, ObjectId activityObjectId) throws BusinessObjectException
      Class constructor specifying the Session and the individual components of the multi-part key: FinancialPeriodObjectId and ActivityObjectId. This constructor is most commonly used when update() is intended to be called on this object.
      Parameters:
      session - the Session
      financialPeriodObjectId - the first ObjectId in the key
      activityObjectId - the second ObjectId in the key
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • ActivityPeriodActual

      public ActivityPeriodActual(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
      Class constructor called internally after objects are retrieved from the server. Client code should use one of the other constructors for this class.
      Parameters:
      session - the Session
      rowSet - the PrmRowSet retrieved from the server
      iIndex - the row index in the PrmRowSet associated with this business object
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

  • Method Details

    • loadFinancialPeriod

      public FinancialPeriod loadFinancialPeriod(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated FinancialPeriod object from the database.
      Parameters:
      fields - fields to load
      Returns:
      FinancialPeriod the FinancialPeriod object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • loadActivity

      public Activity loadActivity(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated Activity object from the database.
      Parameters:
      fields - fields to load
      Returns:
      Activity the Activity object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • loadProject

      public Project loadProject(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated Project object from the database.
      Parameters:
      fields - fields to load
      Returns:
      Project the Project object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getFinancialPeriodObjectId

      public ObjectId getFinancialPeriodObjectId() throws BusinessObjectException
      Gets the unique ID of the associated financial period. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.
      Returns:
      the value in the field FinancialPeriodObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setFinancialPeriodObjectId

      public void setFinancialPeriodObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated financial period. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActivityObjectId

      public ObjectId getActivityObjectId() throws BusinessObjectException
      Gets the unique ID of the associated activity. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.
      Returns:
      the value in the field ActivityObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActivityObjectId

      public void setActivityObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated activity. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getProjectObjectId

      public ObjectId getProjectObjectId() throws BusinessObjectException
      Gets the unique ID of the associated project. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field ProjectObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getWBSObjectId

      public ObjectId getWBSObjectId() throws BusinessObjectException
      Gets the unique ID of the WBS for the activity. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field WBSObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getFinancialPeriodTemplateId

      public ObjectId getFinancialPeriodTemplateId() throws BusinessObjectException
      Gets the id of the financial period template to which the financial period belongs.
      Returns:
      the value in the field FinancialPeriodTemplateId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualLaborUnits

      public Unit getActualLaborUnits() throws BusinessObjectException
      Gets the actual labor units on this activity during a financial period.
      Returns:
      the value in the field ActualLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualLaborUnits

      public void setActualLaborUnits(Unit u) throws BusinessObjectException
      Sets the actual labor units on this activity during a financial period.
      Parameters:
      u - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualLaborCost

      public Cost getActualLaborCost() throws BusinessObjectException
      Gets the actual labor cost on this activity during a financial period.
      Returns:
      the value in the field ActualLaborCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualLaborCost

      public void setActualLaborCost(Cost c) throws BusinessObjectException
      Sets the actual labor cost on this activity during a financial period.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualNonLaborUnits

      public Unit getActualNonLaborUnits() throws BusinessObjectException
      Gets the actual nonlabor units on this activity during a financial period.
      Returns:
      the value in the field ActualNonLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualNonLaborUnits

      public void setActualNonLaborUnits(Unit u) throws BusinessObjectException
      Sets the actual nonlabor units on this activity during a financial period.
      Parameters:
      u - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualNonLaborCost

      public Cost getActualNonLaborCost() throws BusinessObjectException
      Gets the actual nonlabor cost on this activity during a financial period.
      Returns:
      the value in the field ActualNonLaborCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualNonLaborCost

      public void setActualNonLaborCost(Cost c) throws BusinessObjectException
      Sets the actual nonlabor cost on this activity during a financial period.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualMaterialCost

      public Cost getActualMaterialCost() throws BusinessObjectException
      Gets the actual material cost on this activity during a financial period.
      Returns:
      the value in the field ActualMaterialCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualMaterialCost

      public void setActualMaterialCost(Cost c) throws BusinessObjectException
      Sets the actual material cost on this activity during a financial period.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualExpenseCost

      public Cost getActualExpenseCost() throws BusinessObjectException
      Gets the actual expense cost on this activity during a financial period.
      Returns:
      the value in the field ActualExpenseCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualExpenseCost

      public void setActualExpenseCost(Cost c) throws BusinessObjectException
      Sets the actual expense cost on this activity during a financial period.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getEarnedValueCost

      public Cost getEarnedValueCost() throws BusinessObjectException
      Gets the earned value cost on this activity during a financial period.
      Returns:
      the value in the field EarnedValueCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setEarnedValueCost

      public void setEarnedValueCost(Cost c) throws BusinessObjectException
      Sets the earned value cost on this activity during a financial period.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getEarnedValueLaborUnits

      public Unit getEarnedValueLaborUnits() throws BusinessObjectException
      Gets the earned value labor units on this activity during a financial period.
      Returns:
      the value in the field EarnedValueLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setEarnedValueLaborUnits

      public void setEarnedValueLaborUnits(Unit u) throws BusinessObjectException
      Sets the earned value labor units on this activity during a financial period.
      Parameters:
      u - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPlannedValueCost

      public Cost getPlannedValueCost() throws BusinessObjectException
      Gets the planned value cost on this activity during a financial period.
      Returns:
      the value in the field PlannedValueCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPlannedValueCost

      public void setPlannedValueCost(Cost c) throws BusinessObjectException
      Sets the planned value cost on this activity during a financial period.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPlannedValueLaborUnits

      public Unit getPlannedValueLaborUnits() throws BusinessObjectException
      Gets the planned value labor units on this activity during a financial period.
      Returns:
      the value in the field PlannedValueLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPlannedValueLaborUnits

      public void setPlannedValueLaborUnits(Unit u) throws BusinessObjectException
      Sets the planned value labor units on this activity during a financial period.
      Parameters:
      u - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateDate

      public Date getCreateDate() throws BusinessObjectException
      Gets the date this activity period actual was created.
      Returns:
      the value in the field CreateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLastUpdateDate

      public Date getLastUpdateDate() throws BusinessObjectException
      Gets the date this activity period actual was last updated.
      Returns:
      the value in the field LastUpdateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateUser

      public String getCreateUser() throws BusinessObjectException
      Gets the name of the user that created this activity period actual.
      Returns:
      the value in the field CreateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLastUpdateUser

      public String getLastUpdateUser() throws BusinessObjectException
      Gets the name of the user that last updated this activity period actual.
      Returns:
      the value in the field LastUpdateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsBaseline

      public boolean getIsBaseline() throws BusinessObjectException
      Gets the boolean value indicating if this business object is related to a Project or Baseline.
      Returns:
      the value in the field IsBaseline
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsTemplate

      public boolean getIsTemplate() throws BusinessObjectException
      Gets the boolean value indicating if this business object is related to a template Project.
      Returns:
      the value in the field IsTemplate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRequiredCreateFields

      public static String[] getRequiredCreateFields()
      Gets all fields that must be set before calling create() on this business object. Generally the array will contain one field in each position, but if this business object requires either one field or another field to be set, both of those fields will appear in an element of the returned array separated by '|'. For example, if this business object requires field A to always be set, and field B or field C to be set, one element in the returned array will contain A, and one element will contain B|C.
      Returns:
      String[] an array of required create fields

    • getFilterableFields

      public static String[] getFilterableFields()
      Gets all fields that can be filtered.
      Returns:
      String[] an array of filterable fields

    • getInternalDefaultLoadFields

      public static String[] getInternalDefaultLoadFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getAllFields

      public static String[] getAllFields()
      Gets all fields for this business object.
      Returns:
      String[] an array of all fields

    • getInternalAllFields

      public static String[] getInternalAllFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getInternalAllFieldsSet

      public static Set<String> getInternalAllFieldsSet()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getWritableFields

      public static String[] getWritableFields()
      Gets all writable fields for this business object.
      Returns:
      String[] an array of writable fields

    • getDefaultXMLExportFields

      @Deprecated public static String[] getDefaultXMLExportFields()
      Deprecated.
      Gets the fields that are exported by the hierarchical XML exporter when no fields are specified. This method is no longer relevant since the hierarchical XML exporter has been replaced by the flat XML exporter.
      Returns:
      String[] an array of field names

    • getMinimumXMLExportFields

      public static String[] getMinimumXMLExportFields()
      Gets all fields that are always exported at a minimum by the new flat XML exporter
      Returns:
      String[] an array of exported fields

    • toString

      public String toString()
      Returns a string representation of the object. The output is in XML.
      Overrides:
      toString in class Object
      Returns:
      String a string representation of the object.

    • createObjectId

      public static ObjectId createObjectId(ObjectId financialPeriodObjectId, ObjectId activityObjectId) throws InvalidValueException
      Creates a multi-part ObjectId from two individual ObjectIds.
      Parameters:
      financialPeriodObjectId - the ObjectId of the associated financialPeriod object.
      activityObjectId - the ObjectId of the associated activity object.
      Returns:
      ObjectId the multi-part ObjectId
      Throws:
      InvalidValueException - if one of the input parameters was invalid.
      IllegalArgumentException - if one of the input parameters was null.

    • getObjectId

      public ObjectId getObjectId() throws BusinessObjectException
      Gets the ObjectId for this object. The ObjectId field serves as the primary key for the associated table in the database. For this object, the ObjectId is multi-part, consisting internally of the FinancialPeriodObjectId and ActivityObjectId fields.
      Overrides:
      getObjectId in class BusinessObject
      Returns:
      ObjectId the multi-part ObjectId of this object
      Throws:
      BusinessObjectException - if the ObjectId fields were not loaded.

    • create

      public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
      Creates this ActivityPeriodActual object in the database.
      Returns:
      ObjectId the unique ID of the newly created ActivityPeriodActual object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • create

      public static ObjectId[] create(Session session, ActivityPeriodActual[] activityperiodactuals) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple ActivityPeriodActual objects in the database.
      Parameters:
      session - the Session object
      activityperiodactuals - array of ActivityPeriodActual objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created ActivityPeriodActual objects
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • load

      public static ActivityPeriodActual load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single ActivityPeriodActual object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the ActivityPeriodActual object
      Returns:
      ActivityPeriodActual the ActivityPeriodActual object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • load

      public static BOIterator<ActivityPeriodActual> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple ActivityPeriodActual objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the ActivityPeriodActual objects
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • update

      public void update() throws ServerException, NetworkException, BusinessObjectException
      Updates this ActivityPeriodActual object in the database.
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • update

      public static void update(Session session, ActivityPeriodActual[] activityperiodactuals) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple ActivityPeriodActual objects in the database.
      Parameters:
      session - the Session object
      activityperiodactuals - array of ActivityPeriodActual objects to update
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • delete

      public void delete() throws ServerException, NetworkException, BusinessObjectException
      Deletes this ActivityPeriodActual object from the database.
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • delete

      public static void delete(Session session, ActivityPeriodActual[] activityperiodactuals) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple ActivityPeriodActual objects from the database.
      Parameters:
      session - the Session object
      activityperiodactuals - array of ActivityPeriodActual objects to delete
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects