java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.base.EPSBase
com.primavera.integration.client.bo.object.EPS

public class EPS extends com.primavera.integration.client.bo.base.EPSBase

EPS (Enterprise Project Structure) is the hierarchical structure of projects in the database. It is used to perform top-down budgeting, manage multiple projects, implement coding standards, and maintain security throughout the enterprise.

EPS may be loaded with summarized spreads using the loadWithSummarizedSpreads() methods. The EPS must have been previously summarized using the summarizer job service for summarized spreads to be accessible. After loading, call getEPSSpread() to access the spread data.

Many of the fields exposed in this class are summary fields. To obtain a complete list of these fields, call getSummaryFields(). getMainFields() returns all fields except summary fields.

EPS objects may only be deleted from the database if they and their EPS children have no child projects. To delete an EPS, you must first move or delete all projects that are children of that EPS or of that EPS node's EPS children.

This business object supports user defined fields (UDFs). Use the UDFValue business object to assign UDFs.

See Also:   Quick reference of EPS fields

  • Constructor Details

    • EPS

      public EPS(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
    • EPS

      public EPS(Session session, ObjectId objId) throws BusinessObjectException
      Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() will be called on this object.
      Parameters:
      session - the Session
      objId - the ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • EPS

      public EPS(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

    • loadParentEPS

      public EPS loadParentEPS(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated EPS object from the database.
      Parameters:
      fields - fields to load
      Returns:
      EPS the EPS 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
    • createEPSChild

      public ObjectId createEPSChild(EPS epschild) throws ServerException, NetworkException, BusinessObjectException
      Creates an associated EPS object in the database.
      Parameters:
      epschild - EPSChild object to create
      Returns:
      ObjectId unique ID of the newly created EPS 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
    • createEPSChildren

      public ObjectId[] createEPSChildren(EPS[] epschildren) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple associated EPS objects in the database.
      Parameters:
      epschildren - array of EPSChild objects to create
      Returns:
      ObjectId[] array of object ids of newly created EPS 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
    • loadEPSChildren

      public BOIterator<EPS> loadEPSChildren(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated EPS objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      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
    • loadRootEPS

      public static BOIterator<EPS> loadRootEPS(Session session, String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads the root EPS objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      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
    • createProjectChild

      public ObjectId createProjectChild(Project projectchild) throws ServerException, NetworkException, BusinessObjectException
      Creates an associated Project object in the database.
      Parameters:
      projectchild - ProjectChild object to create
      Returns:
      ObjectId unique ID of the newly created 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
    • createProjectChildren

      public ObjectId[] createProjectChildren(Project[] projectchildren) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple associated Project objects in the database.
      Parameters:
      projectchildren - array of ProjectChild objects to create
      Returns:
      ObjectId[] array of object ids of newly created Project 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
    • loadProjectChildren

      public BOIterator<Project> loadProjectChildren(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated Project objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      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
    • loadProjectChildrenWithSummarizedSpread

      public BOIterator<Project> loadProjectChildrenWithSummarizedSpread(String[] nonSpreadFields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated Project objects with spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      spreadFields - the fields to include in the spread object
      periodType - the period of the spread data (hour, day, etc.)
      startDate - the start date of the spread
      endDate - the end date of the spread
      bIncludeCumulative - indicates whether to include cumulative spread data
      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
    • loadOBS

      Loads an associated OBS object from the database.
      Parameters:
      fields - fields to load
      Returns:
      OBS the OBS 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
    • createEPSNote

      public ObjectId createEPSNote(EPSNote epsnote) throws ServerException, NetworkException, BusinessObjectException
      Creates an associated EPSNote object in the database.
      Parameters:
      epsnote - EPSNote object to create
      Returns:
      ObjectId unique ID of the newly created EPSNote 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
    • createEPSNotes

      public ObjectId[] createEPSNotes(EPSNote[] epsnotes) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple associated EPSNote objects in the database.
      Parameters:
      epsnotes - array of EPSNote objects to create
      Returns:
      ObjectId[] array of object ids of newly created EPSNote 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
    • loadEPSNotes

      public BOIterator<EPSNote> loadEPSNotes(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated EPSNote objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      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
    • updateEPSNotes

      public void updateEPSNotes(EPSNote[] epsnotes) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple associated EPSNote objects in the database.
      Parameters:
      epsnotes - array of EPSNote 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
    • deleteEPSNotes

      public void deleteEPSNotes(EPSNote[] epsnotes) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple associated EPSNote objects from the database.
      Parameters:
      epsnotes - array of EPSNote 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
    • createEPSBudgetChangeLog

      public ObjectId createEPSBudgetChangeLog(EPSBudgetChangeLog epsbudgetchangelog) throws ServerException, NetworkException, BusinessObjectException
      Creates an associated EPSBudgetChangeLog object in the database.
      Parameters:
      epsbudgetchangelog - EPSBudgetChangeLog object to create
      Returns:
      ObjectId unique ID of the newly created EPSBudgetChangeLog 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
    • createEPSBudgetChangeLogs

      public ObjectId[] createEPSBudgetChangeLogs(EPSBudgetChangeLog[] epsbudgetchangelogs) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple associated EPSBudgetChangeLog objects in the database.
      Parameters:
      epsbudgetchangelogs - array of EPSBudgetChangeLog objects to create
      Returns:
      ObjectId[] array of object ids of newly created EPSBudgetChangeLog 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
    • loadEPSBudgetChangeLogs

      public BOIterator<EPSBudgetChangeLog> loadEPSBudgetChangeLogs(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated EPSBudgetChangeLog objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      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
    • updateEPSBudgetChangeLogs

      public void updateEPSBudgetChangeLogs(EPSBudgetChangeLog[] epsbudgetchangelogs) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple associated EPSBudgetChangeLog objects in the database.
      Parameters:
      epsbudgetchangelogs - array of EPSBudgetChangeLog 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
    • deleteEPSBudgetChangeLogs

      public void deleteEPSBudgetChangeLogs(EPSBudgetChangeLog[] epsbudgetchangelogs) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple associated EPSBudgetChangeLog objects from the database.
      Parameters:
      epsbudgetchangelogs - array of EPSBudgetChangeLog 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
    • createEPSFunding

      public ObjectId createEPSFunding(EPSFunding epsfunding) throws ServerException, NetworkException, BusinessObjectException
      Creates an associated EPSFunding object in the database.
      Parameters:
      epsfunding - EPSFunding object to create
      Returns:
      ObjectId unique ID of the newly created EPSFunding 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
    • createEPSFundings

      public ObjectId[] createEPSFundings(EPSFunding[] epsfundings) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple associated EPSFunding objects in the database.
      Parameters:
      epsfundings - array of EPSFunding objects to create
      Returns:
      ObjectId[] array of object ids of newly created EPSFunding 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
    • loadEPSFundings

      public BOIterator<EPSFunding> loadEPSFundings(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated EPSFunding objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      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
    • updateEPSFundings

      public void updateEPSFundings(EPSFunding[] epsfundings) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple associated EPSFunding objects in the database.
      Parameters:
      epsfundings - array of EPSFunding 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
    • deleteEPSFundings

      public void deleteEPSFundings(EPSFunding[] epsfundings) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple associated EPSFunding objects from the database.
      Parameters:
      epsfundings - array of EPSFunding 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
    • createEPSSpendingPlan

      public ObjectId createEPSSpendingPlan(EPSSpendingPlan epsspendingplan) throws ServerException, NetworkException, BusinessObjectException
      Creates an associated EPSSpendingPlan object in the database.
      Parameters:
      epsspendingplan - EPSSpendingPlan object to create
      Returns:
      ObjectId unique ID of the newly created EPSSpendingPlan 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
    • createEPSSpendingPlans

      public ObjectId[] createEPSSpendingPlans(EPSSpendingPlan[] epsspendingplans) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple associated EPSSpendingPlan objects in the database.
      Parameters:
      epsspendingplans - array of EPSSpendingPlan objects to create
      Returns:
      ObjectId[] array of object ids of newly created EPSSpendingPlan 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
    • loadEPSSpendingPlans

      public BOIterator<EPSSpendingPlan> loadEPSSpendingPlans(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated EPSSpendingPlan objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      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
    • updateEPSSpendingPlans

      public void updateEPSSpendingPlans(EPSSpendingPlan[] epsspendingplans) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple associated EPSSpendingPlan objects in the database.
      Parameters:
      epsspendingplans - array of EPSSpendingPlan 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
    • deleteEPSSpendingPlans

      public void deleteEPSSpendingPlans(EPSSpendingPlan[] epsspendingplans) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple associated EPSSpendingPlan objects from the database.
      Parameters:
      epsspendingplans - array of EPSSpendingPlan 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
    • loadActivityCodeTypes

      public BOIterator<ActivityCodeType> loadActivityCodeTypes(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ActivityCodeType objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      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
    • loadUDFValues

      public BOIterator<UDFValue> loadUDFValues(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated UDFValue objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      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
    • loadAllProjects

      public BOIterator<Project> loadAllProjects(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Return all child Projects from this EPS and its all descendent EPS.
      Parameters:
      fields - array of field names
      sWhereClause - where clause
      sOrderBy - order by clause
      Returns:
      BOIterator that contains Projects
      Throws:
      ServerException
      NetworkException
      BusinessObjectException
    • getProjectObjectId

      public ObjectId getProjectObjectId() throws BusinessObjectException
      Gets the internal Project ID of the EPS. This ID cannot be used to load a Project object directly. 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
    • getObjectId

      public ObjectId getObjectId() throws BusinessObjectException
      Gets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Overrides:
      getObjectId in class BusinessObject
      Returns:
      the value in the field ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setObjectId

      public void setObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Overrides:
      setObjectId in class BusinessObject
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getParentObjectId

      public ObjectId getParentObjectId() throws BusinessObjectException
      Gets the unique ID of the parent EPS of this EPS in the hierarchy. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field ParentObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setParentObjectId

      public void setParentObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the parent EPS of this EPS in the hierarchy. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getName

      public String getName() throws BusinessObjectException
      Gets the name of the EPS element.
      Returns:
      the value in the field Name
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setName

      public void setName(String s) throws BusinessObjectException
      Sets the name of the EPS element.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getId

      public String getId() throws BusinessObjectException
      Gets the short code assigned to each EPS element for identification.
      Returns:
      the value in the field Id
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setId

      public void setId(String s) throws BusinessObjectException
      Sets the short code assigned to each EPS element for identification.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getParentEPSName

      public String getParentEPSName() throws BusinessObjectException
      Gets the name assigned to parent of each EPS element for identification.
      Returns:
      the value in the field ParentEPSName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getParentEPSId

      public String getParentEPSId() throws BusinessObjectException
      Gets the short code assigned to parent of each EPS element for identification.
      Returns:
      the value in the field ParentEPSId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getOBSObjectId

      public ObjectId getOBSObjectId() throws BusinessObjectException
      Gets the unique ID of the project manager from the project's OBS tree who is responsible for the EPS. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field OBSObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setOBSObjectId

      public void setOBSObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the project manager from the project's OBS tree who is responsible for the EPS. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getOBSName

      public String getOBSName() throws BusinessObjectException
      Gets the name of the person/role in the organization, sometimes referred to as the "responsible manager".
      Returns:
      the value in the field OBSName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getEPSSpread

      public EPSSpread getEPSSpread() throws BusinessObjectException
      Gets the field containing spread data for this EPS. If an EPS is attempted to be loaded with spread data, getEPSSpread will return null if no spread data was available for that EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field EPSSpread
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSequenceNumber

      public int getSequenceNumber() throws BusinessObjectException
      Gets the sequence number for sorting.
      Returns:
      the value in the field SequenceNumber
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setSequenceNumber

      public void setSequenceNumber(int i) throws BusinessObjectException
      Sets the sequence number for sorting.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getGUID

      public String getGUID() throws BusinessObjectException
      Gets the globally unique ID generated by the system.
      Returns:
      the value in the field GUID
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setGUID

      public void setGUID(String s) throws BusinessObjectException
      Sets the globally unique ID generated by the system.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getStartDate

      public BeginDate getStartDate() throws BusinessObjectException
      Gets the start date of the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field StartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getFinishDate

      public EndDate getFinishDate() throws BusinessObjectException
      Gets the finish date of the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field FinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCurrentBudget

      public Cost getCurrentBudget() throws BusinessObjectException
      Gets the sum of the original budget plus the approved and pending budgets from the budget change log. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field CurrentBudget
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getDistributedCurrentBudget

      public Cost getDistributedCurrentBudget() throws BusinessObjectException
      Gets the current budget values from one level lower. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field DistributedCurrentBudget
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getIndependentETCTotalCost

      public Cost getIndependentETCTotalCost() throws BusinessObjectException
      Gets the user-entered ETC total cost.
      Returns:
      the value in the field IndependentETCTotalCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getPlannedStartDate

      public BeginDate getPlannedStartDate() throws BusinessObjectException
      Gets the planned start date of the project. Used by the project scheduler.
      Returns:
      the value in the field PlannedStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCurrentVariance

      public Cost getCurrentVariance() throws BusinessObjectException
      Gets the difference between the current budget and the total spending plan. Calculated as current budget - total spending plan. Not rolled up. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field CurrentVariance
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getUndistributedCurrentVariance

      public Cost getUndistributedCurrentVariance() throws BusinessObjectException
      Gets the total spending plan minus the total spending plan tally. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field UndistributedCurrentVariance
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getOriginalBudget

      public Cost getOriginalBudget() throws BusinessObjectException
      Gets the original budget for the project.
      Returns:
      the value in the field OriginalBudget
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setOriginalBudget

      public void setOriginalBudget(Cost c) throws BusinessObjectException
      Sets the original budget for the project.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTotalBenefitPlan

      public Cost getTotalBenefitPlan() throws BusinessObjectException
      Gets the sum of the monthly benefit plan. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TotalBenefitPlan
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTotalBenefitPlanTally

      public Cost getTotalBenefitPlanTally() throws BusinessObjectException
      Gets the sum of the monthly benefit plan tally. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TotalBenefitPlanTally
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTotalSpendingPlan

      public Cost getTotalSpendingPlan() throws BusinessObjectException
      Gets the sum of the monthly spending plan. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TotalSpendingPlan
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTotalSpendingPlanTally

      public Cost getTotalSpendingPlanTally() throws BusinessObjectException
      Gets the sum of the monthly spending plan tally. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TotalSpendingPlanTally
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getLastSummarizedDate

      public Date getLastSummarizedDate() throws BusinessObjectException
      Gets the date the project was last summarized.
      Returns:
      the value in the field LastSummarizedDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getUnallocatedBudget

      public Cost getUnallocatedBudget() throws BusinessObjectException
      Gets the total current budget minus the distributed current budget. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field UnallocatedBudget
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getProposedBudget

      public Cost getProposedBudget() throws BusinessObjectException
      Gets the Proposed Budget, which is the sum of the original budget plus the approved and pending budgets from the budget change log. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field ProposedBudget
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getAnticipatedFinishDate

      public EndDate getAnticipatedFinishDate() throws BusinessObjectException
      Gets the anticipated finish date of the EPS. User-entered - not dependent upon any other fields. If there are no children, the anticipated finish date will be the finish date displayed in the columns.
      Returns:
      the value in the field AnticipatedFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setAnticipatedFinishDate

      public void setAnticipatedFinishDate(EndDate d) throws BusinessObjectException
      Sets the anticipated finish date of the EPS. User-entered - not dependent upon any other fields. If there are no children, the anticipated finish date will be the finish date displayed in the columns.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getAnticipatedStartDate

      public BeginDate getAnticipatedStartDate() throws BusinessObjectException
      Gets the anticipated start date of the EPS. User-entered - not dependent upon any other fields. If there are no children, the anticipated start date will be the start date displayed in the columns.
      Returns:
      the value in the field AnticipatedStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setAnticipatedStartDate

      public void setAnticipatedStartDate(BeginDate d) throws BusinessObjectException
      Sets the anticipated start date of the EPS. User-entered - not dependent upon any other fields. If there are no children, the anticipated start date will be the start date displayed in the columns.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getIndependentETCLaborUnits

      public Unit getIndependentETCLaborUnits() throws BusinessObjectException
      Gets the user-entered ETC total labor.
      Returns:
      the value in the field IndependentETCLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActualValueByCost

      public Cost getSummaryActualValueByCost() throws BusinessObjectException
      Gets the actual total cost incurred on the activity as of the project data date, computed as Actual Labor Cost + Actual Nonlabor Cost + Actual Material Cost + Actual Expense Cost. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActualValueByCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryPlannedValueByCost

      public Cost getSummaryPlannedValueByCost() throws BusinessObjectException
      Gets the Budget at Completion * Schedule % Complete. The Schedule % Complete specifies how much of the activity's baseline duration has been completed so far. Budget at Completion is computed from the primary baseline. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryPlannedValueByCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryEarnedValueByCost

      public Cost getSummaryEarnedValueByCost() throws BusinessObjectException
      Gets the Budget at Completion * Performance % Complete. The method for computing the Performance Percent Complete depends on the Earned Value technique selected for the activity's WBS. Budget at Completion is computed from the primary baseline. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryEarnedValueByCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryCostPerformanceIndexByCost

      public double getSummaryCostPerformanceIndexByCost() throws BusinessObjectException
      Gets the Earned Value divided by the Actual Cost. A value less than 1 indicates that the Actual Cost has exceeded the Planned Value. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryCostPerformanceIndexByCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActualFinishDate

      public EndDate getSummaryActualFinishDate() throws BusinessObjectException
      Gets the latest actual finish date of all activities in the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActualFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryRemainingFinishDate

      public EndDate getSummaryRemainingFinishDate() throws BusinessObjectException
      Gets the date the resource is scheduled to finish the remaining work for the activity. This date is computed by the project scheduler but can be updated manually by the project manager. Before the activity is started, the remaining finish date is the same as the planned finish date. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryRemainingFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryBaselineTotalCost

      public Cost getSummaryBaselineTotalCost() throws BusinessObjectException
      Gets the Planned Total Cost for the activity in the primary baseline, including labor resources, nonlabor resources, and project expenses. Baseline Planned Total Cost = Baseline Planned Labor Cost + Baseline Planned Nonlabor Cost + Baseline Planned Expense Cost. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryBaselineTotalCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryBudgetAtCompletionByCost

      public Cost getSummaryBudgetAtCompletionByCost() throws BusinessObjectException
      Gets the Planned Total Cost through activity completion. Computed as Planned Labor Cost + Planned Nonlabor Cost + Planned Expense Cost, same as the Planned Total Cost. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryBudgetAtCompletionByCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryEstimateToCompleteByCost

      public Cost getSummaryEstimateToCompleteByCost() throws BusinessObjectException
      Gets the Remaining Total Cost for the activity or the Performance Factor * (Budget at Completion - Earned Value), depending on the Earned Value technique selected for the activity's WBS (calculated from the primary baseline). This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryEstimateToCompleteByCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryBaselineLaborUnits

      public Unit getSummaryBaselineLaborUnits() throws BusinessObjectException
      Gets the planned units for all labor resources assigned to the activity in the primary baseline. Computed as the baseline actual labor units plus the baseline remaining labor units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryBaselineLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryPlannedValueByLaborUnits

      public Unit getSummaryPlannedValueByLaborUnits() throws BusinessObjectException
      Gets the portion of the baseline labor units that is scheduled to be completed as of the project data date. Computed as Baseline Labor Units * Schedule % Complete. The Schedule % Complete specifies how much of the activity's baseline duration has been completed so far. The Baseline Labor Units is taken from the current baseline. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryPlannedValueByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryEarnedValueByLaborUnits

      public Unit getSummaryEarnedValueByLaborUnits() throws BusinessObjectException
      Gets the Schedule Variance Labor Units divided by the Planned Value Labor Units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryEarnedValueByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActualLaborUnits

      public Unit getSummaryActualLaborUnits() throws BusinessObjectException
      Gets the actual labor units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActualLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryAtCompletionLaborUnits

      public Unit getSummaryAtCompletionLaborUnits() throws BusinessObjectException
      Gets the sum of the actual plus remaining units for all labor resources assigned to the activity. Computed as actual labor units + remaining labor units. Same as the planned labor units if the activity is not started and the actual labor units once the activity is completed. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryAtCompletionLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryAtCompletionNonLaborUnits

      public Unit getSummaryAtCompletionNonLaborUnits() throws BusinessObjectException
      Gets the nonlabor units at completion. It is the sum of the actual plus remaining units for all nonlabor resources assigned to the activity. Computed as actual nonlabor units + remaining nonlabor units. Same as the planned nonlabor units if the activity is not started and the actual nonlabor units once the activity is completed. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryAtCompletionNonLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryBaselineNonLaborUnits

      public Unit getSummaryBaselineNonLaborUnits() throws BusinessObjectException
      Gets the planned units for all nonlabor resources assigned to the activity in the primary baseline. Computed as the baseline actual nonlabor units plus the baseline remaining nonlabor units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryBaselineNonLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryNonLaborUnitsVariance

      public Unit getSummaryNonLaborUnitsVariance() throws BusinessObjectException
      Gets the difference between baseline nonlabor units and at completion non labor units. Calculated as Baseline nonlabor units - at completion nonlabor units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryNonLaborUnitsVariance
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryLaborUnitsVariance

      public Unit getSummaryLaborUnitsVariance() throws BusinessObjectException
      Gets the difference between baseline labor units and at completion labor units. Calculated as Baseline labor units - at completion labor units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryLaborUnitsVariance
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActualThisPeriodLaborCost

      public Cost getSummaryActualThisPeriodLaborCost() throws BusinessObjectException
      Gets the actual this period labor cost. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActualThisPeriodLaborCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActualThisPeriodLaborUnits

      public Unit getSummaryActualThisPeriodLaborUnits() throws BusinessObjectException
      Gets the actual this period labor units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActualThisPeriodLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActualThisPeriodNonLaborCost

      public Cost getSummaryActualThisPeriodNonLaborCost() throws BusinessObjectException
      Gets the actual this period nonlabor cost. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActualThisPeriodNonLaborCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActualThisPeriodMaterialCost

      public Cost getSummaryActualThisPeriodMaterialCost() throws BusinessObjectException
      Gets the actual this period material cost. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActualThisPeriodMaterialCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActualThisPeriodNonLaborUnits

      public Unit getSummaryActualThisPeriodNonLaborUnits() throws BusinessObjectException
      Gets the actual this period nonlabor units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActualThisPeriodNonLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActualThisPeriodCost

      public Cost getSummaryActualThisPeriodCost() throws BusinessObjectException
      Gets the actual this period cost (will be labor or nonlabor). This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActualThisPeriodCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryLaborUnitsPercentComplete

      public Percent getSummaryLaborUnitsPercentComplete() throws BusinessObjectException
      Gets the percent complete of units for all labor resources for the EPS. Computed as actual labor units / at complete labor units * 100. Always in the range 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryLaborUnitsPercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryCostPercentOfPlanned

      public Percent getSummaryCostPercentOfPlanned() throws BusinessObjectException
      Gets the activity actual cost percent of planned. Computed as actual total cost / baseline total cost * 100, or equivalently as ACWP / BAC * 100. The value can exceed 100. The baseline total cost is the activity's at completion cost from the current baseline. This field is named SummaryCostPercentOfBudget in Primavera's Engineering & Construction and Maintenance & Turnaround solutions. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryCostPercentOfPlanned
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryBaselineStartDate

      public BeginDate getSummaryBaselineStartDate() throws BusinessObjectException
      Gets the current earliest start date of all activities in the EPS for the current baseline. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryBaselineStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryBaselineFinishDate

      public EndDate getSummaryBaselineFinishDate() throws BusinessObjectException
      Gets the current latest finish date of all activities in the EPS for the current baseline. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryBaselineFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryRemainingDuration

      public Duration getSummaryRemainingDuration() throws BusinessObjectException
      Gets the total working time from the EPS remaining start date to the remaining finish date. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryRemainingDuration
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryFinishDateVariance

      public Duration getSummaryFinishDateVariance() throws BusinessObjectException
      Gets the duration between the finish date in the current project and the baseline finish date. Calculated as finish date - baseline finish date. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryFinishDateVariance
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryBaselineDuration

      public Duration getSummaryBaselineDuration() throws BusinessObjectException
      Gets the planned duration for the activity in the primary baseline. Planned duration is the total working time from the activity current start date to the current finish date. Same as the actual duration plus the remaining duration. The total working time is computed using the activity's calendar. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryBaselineDuration
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryDurationPercentComplete

      public Percent getSummaryDurationPercentComplete() throws BusinessObjectException
      Gets the activity actual duration percent of planned. Computed as (baseline planned duration - remaining duration) / baseline planned duration * 100. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryDurationPercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryProgressFinishDate

      public EndDate getSummaryProgressFinishDate() throws BusinessObjectException
      Gets the date the activity is expected to be finished according to the progress made on the activity's work products. The expected finish date is entered manually by people familiar with progress of the activity's work products. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryProgressFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryEstimateToCompleteByLaborUnits

      public Unit getSummaryEstimateToCompleteByLaborUnits() throws BusinessObjectException
      Gets the estimated quantity to complete the activity. Computed as either the remaining total units for the activity, or as Performance Factor * (Baseline Planned Labor Units - Planned Quantity of Work Performed), depending on the Earned Value Technique selected for the activity's WBS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryEstimateToCompleteByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryCostPerformanceIndexByLaborUnits

      public double getSummaryCostPerformanceIndexByLaborUnits() throws BusinessObjectException
      Gets the Earned Value Labor Units / Actual Labor Units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryCostPerformanceIndexByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryScheduleVarianceByCost

      public Cost getSummaryScheduleVarianceByCost() throws BusinessObjectException
      Gets the Earned Value divided by the Planned Value. A negative value indicates that less work was actually performed than was scheduled. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryScheduleVarianceByCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryScheduleVarianceIndexByCost

      public Percent getSummaryScheduleVarianceIndexByCost() throws BusinessObjectException
      Gets the Schedule Variance divided by the Planned Value. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryScheduleVarianceIndexByCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryScheduleVarianceByLaborUnits

      public Unit getSummaryScheduleVarianceByLaborUnits() throws BusinessObjectException
      Gets the Earned Value Labor Units minus the Planned Value Labor Units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryScheduleVarianceByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryCostVarianceByCost

      public Cost getSummaryCostVarianceByCost() throws BusinessObjectException
      Gets the Earned Value minus the Actual Cost. A negative value indicates that the Actual Cost has exceeded the Planned Value. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryCostVarianceByCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryCostVarianceIndexByCost

      public Percent getSummaryCostVarianceIndexByCost() throws BusinessObjectException
      Gets the Cost Variance divided by Earned Value. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryCostVarianceIndexByCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryCostVarianceByLaborUnits

      public Unit getSummaryCostVarianceByLaborUnits() throws BusinessObjectException
      Gets the Earned Value Labor Cost minus Actual Value Labor Cost. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryCostVarianceByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummarySchedulePerformanceIndexByCost

      public double getSummarySchedulePerformanceIndexByCost() throws BusinessObjectException
      Gets the Earned Value divided by the Planned Value. A value less than 1 indicates that less work was actually performed than was scheduled. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummarySchedulePerformanceIndexByCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummarySchedulePerformanceIndexByLaborUnits

      public double getSummarySchedulePerformanceIndexByLaborUnits() throws BusinessObjectException
      Gets the Earned Value Labor Units divided by Planned Value Labor Units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummarySchedulePerformanceIndexByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryEstimateAtCompletionByCost

      public Cost getSummaryEstimateAtCompletionByCost() throws BusinessObjectException
      Gets the Actual Cost plus the Estimate to Complete Cost. The method for computing Estimate to Complete depends on the Earned Value technique selected for the activity's WBS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryEstimateAtCompletionByCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryEstimateAtCompletionByLaborUnits

      public Unit getSummaryEstimateAtCompletionByLaborUnits() throws BusinessObjectException
      Gets the Actual Labor Units + Estimate To Complete Labor Units. (Estimate To Complete Labor Units is calculated based off of the Earned Value setting on the EPS.). This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryEstimateAtCompletionByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryToCompletePerformanceIndexByCost

      public double getSummaryToCompletePerformanceIndexByCost() throws BusinessObjectException
      Gets the (Budget at Completion - Earned Value) divided by (Estimate at Completion - Actual Cost). This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryToCompletePerformanceIndexByCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryVarianceAtCompletionByLaborUnits

      public Unit getSummaryVarianceAtCompletionByLaborUnits() throws BusinessObjectException
      Gets the Baseline Planned Total Labor Units minus Estimate at Completion Labor Units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryVarianceAtCompletionByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActualStartDate

      public BeginDate getSummaryActualStartDate() throws BusinessObjectException
      Gets the earliest actual start date of all activities in the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActualStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryRemainingStartDate

      public BeginDate getSummaryRemainingStartDate() throws BusinessObjectException
      Gets the earliest remaining start of all activities assigned to the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryRemainingStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActualNonLaborUnits

      public Unit getSummaryActualNonLaborUnits() throws BusinessObjectException
      Gets the actual nonlabor units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActualNonLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActualLaborCost

      public Cost getSummaryActualLaborCost() throws BusinessObjectException
      Gets the actual cost for all labor resources assigned to the activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActualLaborCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActualNonLaborCost

      public Cost getSummaryActualNonLaborCost() throws BusinessObjectException
      Gets the actual units for all nonlabor resources assigned to the activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActualNonLaborCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActualMaterialCost

      public Cost getSummaryActualMaterialCost() throws BusinessObjectException
      Gets the actual units for all material resources assigned to the activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActualMaterialCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryRemainingTotalCost

      public Cost getSummaryRemainingTotalCost() throws BusinessObjectException
      Gets the sum of all remaining total costs in the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryRemainingTotalCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryRemainingNonLaborUnits

      public Unit getSummaryRemainingNonLaborUnits() throws BusinessObjectException
      Gets the remaining units for all nonlabor resources assigned to the activities. The remaining units reflects the work remaining to be done for the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryRemainingNonLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActualExpenseCost

      public Cost getSummaryActualExpenseCost() throws BusinessObjectException
      Gets the actual costs for all project expenses associated with the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActualExpenseCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryRemainingLaborUnits

      public Unit getSummaryRemainingLaborUnits() throws BusinessObjectException
      Gets the remaining units for all labor resources assigned to the activities. The remaining units reflects the work remaining to be done for the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryRemainingLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryAtCompletionTotalCost

      public Cost getSummaryAtCompletionTotalCost() throws BusinessObjectException
      Gets the estimated cost at completion for the activity. Computed as the actual total cost plus the estimate-to-complete cost; EAC = ACWP + ETC. Note that the method for computing ETC depends on the earned-value technique selected for the activity's WBS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryAtCompletionTotalCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryRemainingLaborCost

      public Cost getSummaryRemainingLaborCost() throws BusinessObjectException
      Gets the remaining costs for all labor resources assigned to the activities. The remaining cost reflects the cost remaining for the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryRemainingLaborCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryRemainingNonLaborCost

      public Cost getSummaryRemainingNonLaborCost() throws BusinessObjectException
      Gets the remaining nonlabor costs for all project expenses associated with the activities in the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryRemainingNonLaborCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryRemainingMaterialCost

      public Cost getSummaryRemainingMaterialCost() throws BusinessObjectException
      Gets the remaining material costs for all project expenses associated with the activities in the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryRemainingMaterialCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryRemainingExpenseCost

      public Cost getSummaryRemainingExpenseCost() throws BusinessObjectException
      Gets the remaining costs for all project expenses associated with the activities in the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryRemainingExpenseCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryBaselineExpenseCost

      public Cost getSummaryBaselineExpenseCost() throws BusinessObjectException
      Gets the planned cost for all project expenses associated with the activity in the primary baseline. Computed as the baseline actual expense cost plus the baseline remaining expense cost. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryBaselineExpenseCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryBaselineLaborCost

      public Cost getSummaryBaselineLaborCost() throws BusinessObjectException
      Gets the planned cost for all labor resources assigned to the activity in the primary baseline. Computed from the baseline At Completion labor units. If no resources are assigned, computed as the activity Baseline Planned Labor Units * Project Default Price / Time. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryBaselineLaborCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryBaselineNonLaborCost

      public Cost getSummaryBaselineNonLaborCost() throws BusinessObjectException
      Gets the planned cost for all nonlabor resources assigned to the activity in the primary baseline. Computed from the baseline At Completion nonlabor units. If no resources are assigned, computed as the activity Baseline Planned Nonlabor Units * Project Default Price / Time. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryBaselineNonLaborCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryBaselineMaterialCost

      public Cost getSummaryBaselineMaterialCost() throws BusinessObjectException
      Gets the planned cost for all material resources assigned to the activity in the primary baseline. Computed from the baseline At Completion nonlabor units. If no resources are assigned. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryBaselineMaterialCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryAtCompletionDuration

      public Duration getSummaryAtCompletionDuration() throws BusinessObjectException
      Gets the duration at completion. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryAtCompletionDuration
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryDurationVariance

      public Duration getSummaryDurationVariance() throws BusinessObjectException
      Gets the duration between the activity's baseline duration and the at complete duration. Computed as baseline duration - at completion duration. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryDurationVariance
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryStartDateVariance

      public Duration getSummaryStartDateVariance() throws BusinessObjectException
      Gets the duration between the start date in the current project and the baseline start date. Calculated as start date - baseline start date. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryStartDateVariance
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActivityCount

      public int getSummaryActivityCount() throws BusinessObjectException
      Gets the number of activities that are currently in progress. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActivityCount
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryCompletedActivityCount

      public int getSummaryCompletedActivityCount() throws BusinessObjectException
      Gets the number of activities that have an Actual Finish in the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryCompletedActivityCount
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryInProgressActivityCount

      public int getSummaryInProgressActivityCount() throws BusinessObjectException
      Gets the number of activities that are currently in progress. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryInProgressActivityCount
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryNotStartedActivityCount

      public int getSummaryNotStartedActivityCount() throws BusinessObjectException
      Gets the number of activities that are currently not started. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryNotStartedActivityCount
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryBaselineCompletedActivityCount

      public int getSummaryBaselineCompletedActivityCount() throws BusinessObjectException
      Gets the number of completed activities in the baseline. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryBaselineCompletedActivityCount
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryBaselineInProgressActivityCount

      public int getSummaryBaselineInProgressActivityCount() throws BusinessObjectException
      Gets the number of activities that should be currently in progress, according to the primary baseline. Computed using the baseline start and finish dates and the current data date. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryBaselineInProgressActivityCount
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryBaselineNotStartedActivityCount

      public int getSummaryBaselineNotStartedActivityCount() throws BusinessObjectException
      Gets the number of activities not started in the baseline. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryBaselineNotStartedActivityCount
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryAtCompletionLaborCost

      public Cost getSummaryAtCompletionLaborCost() throws BusinessObjectException
      Gets the sum of the actual plus remaining costs for all labor resources assigned to the activity. Computed as actual labor cost + remaining labor cost. Same as the planned labor costs if the activity is not started and the actual labor costs once the activity is completed. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryAtCompletionLaborCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryAtCompletionNonLaborCost

      public Cost getSummaryAtCompletionNonLaborCost() throws BusinessObjectException
      Gets the nonlabor cost at completion. It is the sum of the actual plus remaining costs for all nonlabor resources assigned to the activity. Computed as actual nonlabor cost + remaining nonlabor cost. Same as the planned nonlabor costs if the activity is not started and the actual nonlabor costs once the activity is completed. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryAtCompletionNonLaborCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryAtCompletionMaterialCost

      public Cost getSummaryAtCompletionMaterialCost() throws BusinessObjectException
      Gets the material cost at completion. It is the sum of the actual plus remaining costs for all material resources assigned to the activity. Computed as actual material cost + remaining material cost. Same as the planned material costs if the activity is not started and the actual material costs once the activity is completed. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryAtCompletionMaterialCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryTotalCostVariance

      public Cost getSummaryTotalCostVariance() throws BusinessObjectException
      Gets the value that is calculated as baseline total cost - total cost. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryTotalCostVariance
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryTotalFloat

      public Duration getSummaryTotalFloat() throws BusinessObjectException
      Gets the amount of time the EPS can be delayed before delaying the project finish date. Total float can be computed as late start - early start or as late finish - early finish; this option can be set when running the project scheduler. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryTotalFloat
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryPerformancePercentCompleteByCost

      public Percent getSummaryPerformancePercentCompleteByCost() throws BusinessObjectException
      Gets the percent complete of performance for all labor resources, nonlabor resources, and expenses. Computed as Earned Value / Budget At Completion * 100. Always in the range 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryPerformancePercentCompleteByCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummarySchedulePercentComplete

      public Percent getSummarySchedulePercentComplete() throws BusinessObjectException
      Gets the measure that indicates how much of the EPS baseline duration has been completed so far. Computed based on where the current data date falls between the activity's baseline start and finish dates. If the data date is earlier than the Baseline start, the schedule % complete is 0. If the data date is later than the Baseline finish, the schedule % complete is 100. The schedule % complete indicates how much of the EPS duration should be currently completed, relative to the selected baseline. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummarySchedulePercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActualDuration

      public Duration getSummaryActualDuration() throws BusinessObjectException
      Gets the actual duration. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActualDuration
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryNonLaborUnitsPercentComplete

      public Percent getSummaryNonLaborUnitsPercentComplete() throws BusinessObjectException
      Gets the percent complete of units for all nonlabor resources for the EPS. Computed as Actual Nonlabor Cost / At Completion Nonlabor Cost * 100. Always in the range 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryNonLaborUnitsPercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActualValueByLaborUnits

      public Unit getSummaryActualValueByLaborUnits() throws BusinessObjectException
      Gets the actual total labor units for the activity as of the project data date (i.e., actual total cost by labor units). This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActualValueByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryAccountingVarianceByLaborUnits

      public Unit getSummaryAccountingVarianceByLaborUnits() throws BusinessObjectException
      Gets the Planned Value Labor Units minus the Actual Units. Negative value indicates that Actual Units have exceeded the Planned Value Labor Units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryAccountingVarianceByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryAccountingVarianceByCost

      public Cost getSummaryAccountingVarianceByCost() throws BusinessObjectException
      Gets the Planned Value minus the Actual Cost. A negative value indicates that the Actual Cost has exceeded the Planned Value. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryAccountingVarianceByCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryBudgetAtCompletionByLaborUnits

      public Unit getSummaryBudgetAtCompletionByLaborUnits() throws BusinessObjectException
      Gets the Baseline Labor Units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryBudgetAtCompletionByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryCostVarianceIndexByLaborUnits

      public double getSummaryCostVarianceIndexByLaborUnits() throws BusinessObjectException
      Gets the Cost Variance Labor Units divided by Earned Value Labor Units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryCostVarianceIndexByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryScheduleVarianceIndexByLaborUnits

      public double getSummaryScheduleVarianceIndexByLaborUnits() throws BusinessObjectException
      Gets the Schedule Variance Labor Units divided by the Planned Value Labor Units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryScheduleVarianceIndexByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryEstimateAtCompletionLowPercentByLaborUnits

      public Percent getSummaryEstimateAtCompletionLowPercentByLaborUnits() throws BusinessObjectException
      Gets the low forecast of Estimate At Completion (EAC) by labor units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryEstimateAtCompletionLowPercentByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryEstimateAtCompletionHighPercentByLaborUnits

      public Percent getSummaryEstimateAtCompletionHighPercentByLaborUnits() throws BusinessObjectException
      Gets the high forecast of Estimate At Completion (EAC) by labor units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryEstimateAtCompletionHighPercentByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryPerformancePercentCompleteByLaborUnits

      public Percent getSummaryPerformancePercentCompleteByLaborUnits() throws BusinessObjectException
      Gets the percent complete of performance for all labor resources. Computed as earned value labor units / baseline labor units * 100. Always in the range 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryPerformancePercentCompleteByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummarySchedulePercentCompleteByLaborUnits

      public Percent getSummarySchedulePercentCompleteByLaborUnits() throws BusinessObjectException
      Gets the percent complete of units for all labor resources. Computed as Actual Labor Units / At Completion Labor Units * 100. Always in the range 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummarySchedulePercentCompleteByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryActualTotalCost

      public Cost getSummaryActualTotalCost() throws BusinessObjectException
      Gets the actual labor cost + actual nonlabor cost + actual expense cost as of the project data date. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryActualTotalCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryAtCompletionExpenseCost

      public Cost getSummaryAtCompletionExpenseCost() throws BusinessObjectException
      Gets the sum of the actual plus remaining cost for all project expenses associated with the cost account. Computed as Actual Expense Cost + Remaining Expense Cost. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryAtCompletionExpenseCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryLaborCostVariance

      public Cost getSummaryLaborCostVariance() throws BusinessObjectException
      Gets the Baseline Planned Labor Cost - At Completion Labor Cost. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryLaborCostVariance
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryNonLaborCostVariance

      public Unit getSummaryNonLaborCostVariance() throws BusinessObjectException
      Gets the Baseline Planned Nonlabor Cost - At Completion Nonlabor Cost. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryNonLaborCostVariance
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryExpenseCostVariance

      public Cost getSummaryExpenseCostVariance() throws BusinessObjectException
      Gets the Baseline Planned Expense Cost - At Completion Expense Cost (At Completion Expense Cost = Actual Expense Cost + Remaining Expense Cost). This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryExpenseCostVariance
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryAtCompletionTotalCostVariance

      public Cost getSummaryAtCompletionTotalCostVariance() throws BusinessObjectException
      Gets the Baseline Planned Total Cost - At Completion Total Cost. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryAtCompletionTotalCostVariance
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCreateDate

      public Date getCreateDate() throws BusinessObjectException
      Gets the date this EPS 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 EPS 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 EPS.
      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 EPS.
      Returns:
      the value in the field LastUpdateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryMaterialCostPercentComplete

      public Percent getSummaryMaterialCostPercentComplete() throws BusinessObjectException
      Gets the percent complete of cost for all material resources assigned to the EPS. It is computed as Actual Material Cost / At Complete Material Cost * 100, and it is always in the range of 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryMaterialCostPercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryNonLaborCostPercentComplete

      public Percent getSummaryNonLaborCostPercentComplete() throws BusinessObjectException
      Gets the percent complete of cost for all non-labor resources assigned to the EPS. It is computed as Actual Nonlabor Cost / At Complete Nonlabor Cost * 100, and it is always in the range of 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryNonLaborCostPercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryDurationPercentOfPlanned

      public Percent getSummaryDurationPercentOfPlanned() throws BusinessObjectException
      Gets the summary actual duration percent of planned of all activities under this EPS. Computed as actual duration / baseline duration * 100. The value can exceed 100. The Baseline duration is the activity's at complete duration from the current baseline. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryDurationPercentOfPlanned
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryExpenseCostPercentComplete

      public Percent getSummaryExpenseCostPercentComplete() throws BusinessObjectException
      Gets the percent complete of cost for all expenses associated with the EPS. It is computed as Actual Expense Cost / At Complete Expense Cost * 100, and it is always in the range of 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryExpenseCostPercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryLaborCostPercentComplete

      public Percent getSummaryLaborCostPercentComplete() throws BusinessObjectException
      Gets the percent complete of cost for all labor resources assigned to the EPS. It is computed as Actual Labor Cost / At Complete Labor Cost * 100, and it is always in the range of 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryLaborCostPercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryMaterialCostVariance

      public Cost getSummaryMaterialCostVariance() throws BusinessObjectException
      Gets the variance that is calculated as Baseline Material Cost - At Completion Material Cost. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryMaterialCostVariance
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryCostPercentComplete

      public Percent getSummaryCostPercentComplete() throws BusinessObjectException
      Gets the percent complete of costs for the resource assignments in the EPS. Computed as Actual Units / At Complete Units * 100. Always in the range 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryCostPercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryCostVarianceIndex

      public double getSummaryCostVarianceIndex() throws BusinessObjectException
      Gets the value that is calculated as the Cost Variance divided by Earned Value. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryCostVarianceIndex
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryScheduleVarianceIndex

      public double getSummaryScheduleVarianceIndex() throws BusinessObjectException
      Gets the value that is calculated as the Schedule Variance Labor Units divided by Planned Value Labor Units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryScheduleVarianceIndex
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTotalFunding

      public Cost getTotalFunding() throws BusinessObjectException
      Gets the total amount of funding contributed to the project by your funding sources. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TotalFunding
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryUnitsPercentComplete

      public Percent getSummaryUnitsPercentComplete() throws BusinessObjectException
      Gets the percent complete of units for the resource assignments in the EPS. Computed as Actual Units / At Complete Units * 100. Always in the range 0 to 100. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryUnitsPercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryPlannedCost

      public Cost getSummaryPlannedCost() throws BusinessObjectException
      Gets the sum of all planned expense, non labor, labor, and material costs in the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryPlannedCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryPlannedNonLaborCost

      public Cost getSummaryPlannedNonLaborCost() throws BusinessObjectException
      Gets the sum of all planned non labor costs in the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryPlannedNonLaborCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryPlannedExpenseCost

      public Cost getSummaryPlannedExpenseCost() throws BusinessObjectException
      Gets the sum of all planned expense costs in the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryPlannedExpenseCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryPlannedMaterialCost

      public Cost getSummaryPlannedMaterialCost() throws BusinessObjectException
      Gets the sum of all planned material costs in the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryPlannedMaterialCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryPlannedLaborCost

      public Cost getSummaryPlannedLaborCost() throws BusinessObjectException
      Gets the sum of all planned labor costs in the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryPlannedLaborCost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryPlannedNonLaborUnits

      public Unit getSummaryPlannedNonLaborUnits() throws BusinessObjectException
      Gets the sum of all planned non labor units in the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryPlannedNonLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryPlannedLaborUnits

      public Unit getSummaryPlannedLaborUnits() throws BusinessObjectException
      Gets the sum of all planned labor units in the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryPlannedLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryPlannedStartDate

      public BeginDate getSummaryPlannedStartDate() throws BusinessObjectException
      Gets the earliest planned start date of all activities in the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryPlannedStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryPlannedFinishDate

      public EndDate getSummaryPlannedFinishDate() throws BusinessObjectException
      Gets the latest planned finish date of all activities in the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryPlannedFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryPlannedDuration

      public Duration getSummaryPlannedDuration() throws BusinessObjectException
      Gets the total working days between planned start and finish dates in the EPS. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SummaryPlannedDuration
      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
    • getSummaryFields

      public static String[] getSummaryFields()
      Gets all fields in the summary group for this business object.
      Returns:
      String[] an array of fields in this group
    • getMainFields

      public static String[] getMainFields()
      Gets all fields in the main group for this business object.
      Returns:
      String[] an array of fields in this group
    • getSpreadFields

      public static String[] getSpreadFields()
      Gets all spread fields that can be specified in the spreadFields parameter of loadWithSummarizedSpread methods for this business object.
      Returns:
      String[] an array of all spread fields
    • 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.
    • create

      Creates this EPS object in the database.
      Returns:
      ObjectId the unique ID of the newly created EPS 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, EPS[] eps) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple EPS objects in the database.
      Parameters:
      session - the Session object
      eps - array of EPS objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created EPS 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 EPS load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single EPS object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the EPS object
      Returns:
      EPS the EPS 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<EPS> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple EPS objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the EPS 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
    • loadWithSummarizedSpread

      public static EPS loadWithSummarizedSpread(Session session, String[] nonSpreadFields, ObjectId objId, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Loads a EPS object with summarized spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      objId - unique ID of the EPS object
      spreadFields - the fields to include in the spread object
      periodType - the period of the spread data (hour, day, etc.)
      startDate - the start date of the spread
      endDate - the end date of the spread
      bIncludeCumulative - indicates whether to include cumulative spread data
      Returns:
      EPS the EPS 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
    • loadWithSummarizedSpread

      public static BOIterator<EPS> loadWithSummarizedSpread(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple EPS objects with summarized spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      objIds - object ids of the EPS objects
      spreadFields - the fields to include in the spread object
      periodType - the period of the spread data (hour, day, etc.)
      startDate - the start date of the spread
      endDate - the end date of the spread
      bIncludeCumulative - indicates whether to include cumulative spread data
      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

      Updates this EPS 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, EPS[] eps) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple EPS objects in the database.
      Parameters:
      session - the Session object
      eps - array of EPS 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

      Deletes this EPS 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, EPS[] eps) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple EPS objects from the database.
      Parameters:
      session - the Session object
      eps - array of EPS 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