java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.base.ProjectBase
com.primavera.integration.client.bo.object.Project
All Implemented Interfaces:
com.primavera.integration.client.xml.xmlexporter.ChildAccessor

public class Project extends com.primavera.integration.client.bo.base.ProjectBase

A project is a temporary endeavor undertaken to create a unique product, service, or result. Projects usually contain a work breakdown structure (WBS) and activities.

Objects that are children of projects can be accessed depending on where they are located in the WBS structure. Objects that are at the root WBS level can be accessed using "ProjectLevel" methods. Examples: createProjectLevelActivities(), loadProjectLevelIssues(), createProjectLevelRisk(), etc. Objects that are elsewhere in the WBS hierarchy can either be accessed from their parent WBS or by using the "All" methods in project: loadAllProjectNotes(), loadAllActivitySteps(), etc.

Projects may be loaded with summarized spreads (Project, ProjectResource, or ProjectRole) using the loadWithSummarizedSpread(), loadWithProjectResourceSpread(), or loadWithProjectRoleSpread() methods, respectively. The project must have been previously summarized using the summarizer job service for any type of summarized spreads to be accessible. After loading, call the appropriate method (getProjectSpread(), getProjectResourceSpreads(), or getProjectRoleSpreads()) 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 without summary, user-defined, or code assignment fields.

This business object supports user defined fields (UDFs) and codes. Use the UDFValue business object to assign UDFs, and the ProjectCodeAssignment business object to assign ProjectCodes.

See Also:   Quick reference of Project fields

  • Constructor Details

    • Project

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

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

      public Project(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
    • loadAllBaselineProjects

      public BOIterator<BaselineProject> loadAllBaselineProjects(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated BaselineProject 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
    • deleteBaselineProjects

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

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

      public BOIterator<WBS> loadAllWBS(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated WBS 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
    • loadAllWBSWithSummarizedSpread

      public BOIterator<WBS> loadAllWBSWithSummarizedSpread(String[] nonSpreadFields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated WBS 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
    • updateAllWBS

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

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

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

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

      public BOIterator<WBS> loadWBSChildren(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated WBS 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
    • loadWBSChildrenWithSummarizedSpread

      public BOIterator<WBS> loadWBSChildrenWithSummarizedSpread(String[] nonSpreadFields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated WBS 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
    • loadAllProjectThresholds

      public BOIterator<ProjectThreshold> loadAllProjectThresholds(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ProjectThreshold 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
    • deleteProjectThresholds

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

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

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

      public BOIterator<ProjectThreshold> loadProjectLevelThresholds(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ProjectThreshold 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
    • updateProjectLevelThresholds

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

      public BOIterator<Activity> loadAllActivities(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated Activity 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
    • loadAllActivitiesWithLiveSpread

      public BOIterator<Activity> loadAllActivitiesWithLiveSpread(String[] nonSpreadFields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated Activity 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
    • updateAllActivities

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

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

      public ObjectId createProjectLevelActivity(Activity projectlevelactivity) throws ServerException, NetworkException, BusinessObjectException
      Creates an associated Activity object in the database.
      Parameters:
      projectlevelactivity - ProjectLevelActivity object to create
      Returns:
      ObjectId unique ID of the newly created Activity object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • createProjectLevelActivities

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

      public BOIterator<Activity> loadProjectLevelActivities(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated Activity 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
    • 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
    • createProjectLevelIssue

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

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

      public BOIterator<ProjectIssue> loadProjectLevelIssues(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ProjectIssue 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
    • updateProjectLevelIssues

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

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

      public BOIterator<ProjectIssue> loadAllProjectIssues(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ProjectIssue 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
    • createProjectLevelBudgetChangeLog

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

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

      public BOIterator<ProjectBudgetChangeLog> loadProjectLevelBudgetChangeLogs(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ProjectBudgetChangeLog 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
    • updateProjectLevelBudgetChangeLogs

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

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

      public BOIterator<ProjectBudgetChangeLog> loadAllProjectBudgetChangeLogs(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ProjectBudgetChangeLog 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
    • createProjectFunding

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

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

      public BOIterator<ProjectFunding> loadProjectFundings(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ProjectFunding 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
    • updateProjectFundings

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

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

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

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

      public BOIterator<ProjectNote> loadProjectLevelNotes(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ProjectNote 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
    • updateProjectLevelNotes

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

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

      public BOIterator<ProjectNote> loadAllProjectNotes(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ProjectNote 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
    • loadProjectLevelResources

      public BOIterator<ProjectResource> loadProjectLevelResources(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ProjectResource 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
    • loadAllProjectResources

      public BOIterator<ProjectResource> loadAllProjectResources(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ProjectResource 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
    • loadAllProjectResourceQuantities

      public BOIterator<ProjectResourceQuantity> loadAllProjectResourceQuantities(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ProjectResourceQuantity 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
    • createProjectLevelWBSMilestone

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

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

      public BOIterator<WBSMilestone> loadProjectLevelWBSMilestones(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated WBSMilestone 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
    • updateProjectLevelWBSMilestones

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

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

      public BOIterator<WBSMilestone> loadAllWBSMilestones(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated WBSMilestone 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
    • loadAllActivityExpenses

      public BOIterator<ActivityExpense> loadAllActivityExpenses(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ActivityExpense 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
    • loadAllActivityComment

      public BOIterator<ActivityComment> loadAllActivityComment(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ActivityComment 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
    • loadAllActivityNotes

      public BOIterator<ActivityNote> loadAllActivityNotes(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ActivityNote 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
    • loadAllCBSs

      public BOIterator<CBS> loadAllCBSs(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated CBS 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
    • loadAllCBSDurationSummarys

      public BOIterator<CBSDurationSummary> loadAllCBSDurationSummarys(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated CBSDurationSummary 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
    • loadAllActivitySteps

      public BOIterator<ActivityStep> loadAllActivitySteps(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ActivityStep 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
    • loadAllLeanTasks

      public BOIterator<LeanTask> loadAllLeanTasks(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated LeanTask 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
    • loadAllActivityOwners

      public BOIterator<ActivityOwner> loadAllActivityOwners(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ActivityOwner 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
    • loadFinancialPeriodTmpls

      public BOIterator<FinancialPeriodTemplate> loadFinancialPeriodTmpls(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated FinancialPeriodTemplate 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
    • loadAllResourceAssignments

      public BOIterator<ResourceAssignment> loadAllResourceAssignments(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ResourceAssignment 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
    • loadAllResourceAssignmentsWithLiveSpread

      public BOIterator<ResourceAssignment> loadAllResourceAssignmentsWithLiveSpread(String[] nonSpreadFields, String sWhereClause, String sOrderBy, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ResourceAssignment 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
    • loadAllActivityPeriodActuals

      public BOIterator<ActivityPeriodActual> loadAllActivityPeriodActuals(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ActivityPeriodActual 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
    • loadAllResourceAssignmentPeriodActuals

      public BOIterator<ResourceAssignmentPeriodActual> loadAllResourceAssignmentPeriodActuals(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ResourceAssignmentPeriodActual 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
    • loadAllActivityCodeAssignments

      public BOIterator<ActivityCodeAssignment> loadAllActivityCodeAssignments(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ActivityCodeAssignment 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
    • loadAllResourceAssignmentCodeAssignments

      public BOIterator<ResourceAssignmentCodeAssignment> loadAllResourceAssignmentCodeAssignments(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ResourceAssignmentCodeAssignment 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
    • loadAllUDFValues

      public BOIterator<UDFValue> loadAllUDFValues(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
    • loadProjectLevelUDFValues

      public BOIterator<UDFValue> loadProjectLevelUDFValues(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
    • loadResourceHours

      public BOIterator<ResourceHour> loadResourceHours(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ResourceHour 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
    • loadScheduleOptions

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

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

      public BOIterator<Calendar> loadProjectCalendars(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated Calendar 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
    • loadActivityCodeTypes

      public BOIterator<ActivityCodeType> loadActivityCodeTypes(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ActivityCodeType objects from the database. Note: Only ActivityCodeTypes with a scope of Project are included.
      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
    • loadIssueHistories

      public BOIterator<IssueHistory> loadIssueHistories(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated IssueHistory 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
    • createProjectLevelSpendingPlan

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

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

      public BOIterator<ProjectSpendingPlan> loadProjectLevelSpendingPlans(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ProjectSpendingPlan 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
    • updateProjectLevelSpendingPlans

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

      public BOIterator<ProjectSpendingPlan> loadAllProjectSpendingPlans(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ProjectSpendingPlan 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
    • deleteProjectSpendingPlans

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

      public BOIterator<ProjectDocument> loadProjectDocuments(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ProjectDocument 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
    • loadDocuments

      public BOIterator<Document> loadDocuments(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated Document 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
    • loadProjectCodeAssignments

      public BOIterator<ProjectCodeAssignment> loadProjectCodeAssignments(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ProjectCodeAssignment 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
    • loadAllActivityRisks

      public BOIterator<ActivityRisk> loadAllActivityRisks(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ActivityRisk 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
    • loadRiskResponsePlans

      public BOIterator<RiskResponsePlan> loadRiskResponsePlans(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated RiskResponsePlan 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
    • loadRisks

      public BOIterator<Risk> loadRisks(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated Risk 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
    • loadRiskImpacts

      public BOIterator<RiskImpact> loadRiskImpacts(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated RiskImpact 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
    • loadRiskResponseActions

      public BOIterator<RiskResponseAction> loadRiskResponseActions(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated RiskResponseAction 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
    • loadRiskResponseActionImpacts

      public BOIterator<RiskResponseActionImpact> loadRiskResponseActionImpacts(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated RiskResponseActionImpact 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
    • loadRiskMatrix

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

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

      public BOIterator<Relationship> loadRelationships(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated Relationship objects from the database.
      Specified by:
      loadRelationships in interface com.primavera.integration.client.xml.xmlexporter.ChildAccessor
      Overrides:
      loadRelationships in class com.primavera.integration.client.bo.base.ProjectBase
      Parameters:
      fields - array of field names
      sWhereClause - where clause
      sOrderBy - order by clause
      Returns:
      BOIterator that contains Relationships
      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
    • loadAllResources

      public BOIterator<Resource> loadAllResources(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated Resource objects from the database.
      Parameters:
      fields - array of field names
      sWhereClause - where clause
      sOrderBy - order by clause
      Returns:
      BOIterator that contains Resources
      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
    • loadActivitiesNewerThanBaseline

      public BOIterator<Activity> loadActivitiesNewerThanBaseline(String[] fields, String sWhereClause, String sOrderBy, ObjectId blObjId) throws BusinessObjectException, ServerException, NetworkException
      Loads only the activies of the project that are newer than their baseline counterparts.
      Returns:
      BOIterator that contains Activities
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
    • loadActivityUDFValuesNewerThanBaseline

      public BOIterator<UDFValue> loadActivityUDFValuesNewerThanBaseline(String[] fields, String sWhereClause, String sOrderBy, ObjectId blObjId) throws BusinessObjectException, ServerException, NetworkException
      Loads the activity UDFs of the project that are newer than their baseline counterparts, including UDFs where baseline counterparts don't exist.
      Returns:
      BOIterator that contains UDFValues
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
    • loadActivityCodesNewerThanBaseline

      public BOIterator<ActivityCodeAssignment> loadActivityCodesNewerThanBaseline(String[] fields, String sWhereClause, String sOrderBy, ObjectId blObjId) throws BusinessObjectException, ServerException, NetworkException
      Loads the activity codes of the project that are newer than their baseline counterparts, including codes where baseline counterparts don't exist.
      Returns:
      BOIterator that contains ActivityCodeAssignments
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
    • calculateProjectScore

      public int calculateProjectScore(ObjectId[] aProjCodeTypeIds) throws ServerException, NetworkException, BusinessObjectException
      Calculate the project score of this project based on a selected set of ProjectCodeType's.
      Parameters:
      aProjCodeTypeIds - array of ObjectId's of selected ProjectCodeType's
      Returns:
      project score
      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
    • convertToBaseline

      public ObjectId convertToBaseline(ObjectId projectId) throws ServerException, NetworkException, BusinessObjectException
      Converts this project to a baseline of the project provided. The current Project object will become invalid, since it will no longer be a Project, but a BaselineProject.
      Parameters:
      projectId - unique ID of a Project which this project will become a baseline of
      Returns:
      ObjectId unique identifier for the BaselineProject (which is the same as this object's current ID)
      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
    • assignProjectAsBaseline

      public ObjectId assignProjectAsBaseline(ObjectId projectId) throws ServerException, NetworkException, BusinessObjectException
      Converts the provided project to be a baseline of this project. The project provided as a parameter will become a BaselineProject.
      Parameters:
      projectId - unique ID of a Project which will become a baseline of this project
      Returns:
      ObjectId unique identifier for the BaselineProject (which is the same as the ID as passed to the method)
      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
    • createCopy

      Creates a copy of the project. Note: The execution time of this project depends on the number of associated objects of this project. The more business objects that are associated to this Project (e.g Activities), the longer the copy will take.
      Parameters:
      epsId - the EPS Id to use as the EPS of the new project. If null, the EPS of the current project is used
      projOpts - the copy project options. If null, the default options will be used
      wbsOpts - the copy WBS options. If null, the default options will be used
      actOpts - the copy activity options. If null, the default options will be used
      Returns:
      ObjectId unique identifier for the new Project that was created
      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
    • createCopyAsBaseline

      public ObjectId createCopyAsBaseline() throws ServerException, NetworkException, BusinessObjectException
      Copies a copy of the current project and makes the copy a baseline of the current project. The ParentEPSObjectId is required as a loaded field for this process to be successful. This method invokes the copy() method on Project, which can take a long time to process if the Project is very large.
      Returns:
      ObjectId unique identifier for the new BaselineProject that was created
      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
    • createCopyAsReflection

      public ObjectId createCopyAsReflection() throws ServerException, NetworkException, BusinessObjectException
      Copies a copy of the current project and makes the copy a reflection of the current project. The ParentEPSObjectId is required as a loaded field for this process to be successful. This method invokes the copy() method on Project, which can take a long time to process if the Project is very large.
      Returns:
      ObjectId unique identifier for the new reflection Project that was created
      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
    • lockProject

      public boolean lockProject() throws BusinessObjectException, ServerException, NetworkException
      Locks the project in exclusive mode.
      Returns:
      boolean true if successful, otherwise false.
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
    • unlockProject

      public boolean unlockProject() throws BusinessObjectException, ServerException, NetworkException
      Unlocks this project if it was previously exclusively locked by the current user.
      Returns:
      boolean true if successful, otherwise false.
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
    • isProjectLocked

      public boolean isProjectLocked(boolean includeCurrentSession) throws BusinessObjectException, ServerException, NetworkException
      Check whether this project is exclusively locked.
      Parameters:
      includeCurrentSession - if true, this method will return true when this project is exclusively locked by anybody, including current session. If false, this method will return false when this project is exclusively locked by the current API session.
      Returns:
      boolean true if this project is exclusively locked, otherwise false.
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
    • copyBaseline

      public ObjectId copyBaseline(ObjectId baselineProjId) throws ServerException, NetworkException, BusinessObjectException
      Creates a copy of the specified baseline project.
      Parameters:
      baselineProjId - the unique ID of the baseline project to copy.
      Returns:
      ObjectId unique identifier of baseline project that was created.
      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
    • createCopyAsTemplate

      public ObjectId createCopyAsTemplate(ObjectId epsId, CopyProjectOptions projOpts, CopyWBSOptions wbsOpts, CopyActivityOptions actOpts) throws ServerException, NetworkException, BusinessObjectException
      Creates a copy of the current project and makes it a template project.
      Parameters:
      epsId - the EPS Id to use as the EPS of the new template project. If null, the EPS of the current project is used
      projOpts - the copy project options. If null, the default options will be used
      wbsOpts - the copy WBS options. If null, the default options will be used
      actOpts - the copy activity options. If null, the default options will be used
      Returns:
      ObjectId unique identifier for the new Project that was created
      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
    • createProjectFromTemplate

      public ObjectId createProjectFromTemplate(ObjectId epsId, CopyProjectOptions projOpts, CopyWBSOptions wbsOpts, CopyActivityOptions actOpts) throws ServerException, NetworkException, BusinessObjectException
      Creates a project from the specified template project. After executing this method to create a new project from a template, you should set the PlannedStartDate with the appropriate value and then set the DataDate with a value that is equal or later than the PlannedStartDate. You should then schedule the project with the new DataDate to recalculate all of the project data.
      Parameters:
      epsId - the EPS Id to use as the EPS of the new template project. If null, the EPS of the current project is used
      projOpts - the copy project options. If null, the default options will be used
      wbsOpts - the copy WBS options. If null, the default options will be used
      actOpts - the copy activity options. If null, the default options will be used
      Returns:
      ObjectId unique identifier for the new Project that was created
      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
    • copyWBSFromTemplate

      public ObjectId copyWBSFromTemplate(ObjectId destObjectId, ObjectId templateWbsObjectId, CopyWBSOptions copyWBSOptions, CopyActivityOptions copyActivityOptions) throws BusinessObjectException, ServerException, NetworkException
      Copy a WBS structure from a template and place it under a projects wbs.
      Parameters:
      destObjectId - Project where we are to place the template wbs
      templateWbsObjectId - Wbs ObjectId from a template
      Returns:
      ObjectId where the template wbs was placed if successful
      Throws:
      BusinessObjectException - if something was wrong in this Business object
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
    • publishProject

      public void publishProject(ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Publishes the project.
      Parameters:
      objId - of the project.
      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
    • checkScheduleProject

      public void checkScheduleProject(ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Checks schedule of the project.
      Parameters:
      objId - of the project.
      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
    • updateProjectPreferences

      public boolean updateProjectPreferences(ProjectPreferenceOptions projPrefOpts) throws ServerException, NetworkException, BusinessObjectException
      Updates Project Preferences of the project.
      Parameters:
      projPrefOpts - the copy projectPreferences options. If null, the default options will be used
      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
    • 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
    • getWBSObjectId

      public ObjectId getWBSObjectId() throws BusinessObjectException
      Gets the internal WBS ID of the project. This ID cannot be used to load a WBS 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 WBSObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getParentEPSObjectId

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

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

      public String getParentEPSId() throws BusinessObjectException
      Gets the short name of the parent EPS of this project. 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 ParentEPSId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getParentEPSName

      public String getParentEPSName() throws BusinessObjectException
      Gets the name of the parent EPS of this project. 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 ParentEPSName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getExternalCRKey

      public String getExternalCRKey() throws BusinessObjectException
      Gets content repository unique key. 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 ExternalCRKey
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setExternalCRKey

      public void setExternalCRKey(String s) throws BusinessObjectException
      Sets content repository unique key. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getHistoryInterval

      public HistoryInterval getHistoryInterval() throws BusinessObjectException
      Gets the time interval for how historical project data is stored for use in P6 Analytics, could be 'Month', 'Week', 'Quarter', 'Year' and 'Financial Period'.
      Returns:
      the value in the field HistoryInterval
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setHistoryInterval

      public void setHistoryInterval(HistoryInterval enm) throws BusinessObjectException
      Sets the time interval for how historical project data is stored for use in P6 Analytics, could be 'Month', 'Week', 'Quarter', 'Year' and 'Financial Period'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getHistoryLevel

      public HistoryLevel getHistoryLevel() throws BusinessObjectException
      Gets the level of historical project data that is stored for use in P6 Analytics, cab be 'None', 'Project', 'WBS' and 'Activity'.
      Returns:
      the value in the field HistoryLevel
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setHistoryLevel

      public void setHistoryLevel(HistoryLevel enm) throws BusinessObjectException
      Sets the level of historical project data that is stored for use in P6 Analytics, cab be 'None', 'Project', 'WBS' and 'Activity'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getStatusReviewerObjectId

      public String getStatusReviewerObjectId() throws BusinessObjectException
      Gets the ID's of the user reviewing status updates. 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 StatusReviewerObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setStatusReviewerObjectId

      public void setStatusReviewerObjectId(String s) throws BusinessObjectException
      Sets the ID's of the user reviewing status updates. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getStatusReviewerName

      public String getStatusReviewerName() throws BusinessObjectException
      Gets the the name of the user reviewing status updates. 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 StatusReviewerName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setStatusReviewerName

      public void setStatusReviewerName(String s) throws BusinessObjectException
      Sets the the name of the user reviewing status updates. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getAllowStatusReview

      public boolean getAllowStatusReview() throws BusinessObjectException
      Gets the indicator that determines whether status updates to activities in a project are eligible for manual approval before commiting changes.
      Returns:
      the value in the field AllowStatusReview
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setAllowStatusReview

      public void setAllowStatusReview(boolean b) throws BusinessObjectException
      Sets the indicator that determines whether status updates to activities in a project are eligible for manual approval before commiting changes.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getActivityDefaultReviewRequired

      public boolean getActivityDefaultReviewRequired() throws BusinessObjectException
      Gets the indicator that determines whether status changes for new activities must be approved by default. 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 ActivityDefaultReviewRequired
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setActivityDefaultReviewRequired

      public void setActivityDefaultReviewRequired(boolean b) throws BusinessObjectException
      Sets the indicator that determines whether status changes for new activities must be approved by default. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberAssignmentOption

      public String getTeamMemberAssignmentOption() throws BusinessObjectException
      Gets the indicator that determines whether team member can update activity fields, assignment fields, or both. 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 TeamMemberAssignmentOption
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberAssignmentOption

      public void setTeamMemberAssignmentOption(String s) throws BusinessObjectException
      Sets the indicator that determines whether team member can update activity fields, assignment fields, or both. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberResourceAssignmentFields

      public String getTeamMemberResourceAssignmentFields() throws BusinessObjectException
      Gets the list of assignment fields that can be updated by the team member. 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 TeamMemberResourceAssignmentFields
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberResourceAssignmentFields

      public void setTeamMemberResourceAssignmentFields(String s) throws BusinessObjectException
      Sets the list of assignment fields that can be updated by the team member. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberActivityFields

      public String getTeamMemberActivityFields() throws BusinessObjectException
      Gets the list of activity fields that can be updated by the team member. 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 TeamMemberActivityFields
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberActivityFields

      public void setTeamMemberActivityFields(String s) throws BusinessObjectException
      Sets the list of activity fields that can be updated by the team member. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberReadOnlyActivityFields

      public String getTeamMemberReadOnlyActivityFields() throws BusinessObjectException
      Gets the list of activity fields that are currently readOnly. 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 TeamMemberReadOnlyActivityFields
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberReadOnlyActivityFields

      public void setTeamMemberReadOnlyActivityFields(String s) throws BusinessObjectException
      Sets the list of activity fields that are currently readOnly. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberViewableFields

      public String getTeamMemberViewableFields() throws BusinessObjectException
      Gets the list of fields that are viewable by the team member. 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 TeamMemberViewableFields
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberViewableFields

      public void setTeamMemberViewableFields(String s) throws BusinessObjectException
      Sets the list of fields that are viewable by the team member. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberProjectViewableFields

      public String getTeamMemberProjectViewableFields() throws BusinessObjectException
      Gets the list of Project Codes and UDF fields that are viewable by the team member. 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 TeamMemberProjectViewableFields
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberProjectViewableFields

      public void setTeamMemberProjectViewableFields(String s) throws BusinessObjectException
      Sets the list of Project Codes and UDF fields that are viewable by the team member. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberStepUDFViewableFields

      public String getTeamMemberStepUDFViewableFields() throws BusinessObjectException
      Gets the list of step UDF fields that are viewable by the team member. 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 TeamMemberStepUDFViewableFields
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberStepUDFViewableFields

      public void setTeamMemberStepUDFViewableFields(String s) throws BusinessObjectException
      Sets the list of step UDF fields that are viewable by the team member. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberStepsAddDeletable

      public boolean getTeamMemberStepsAddDeletable() throws BusinessObjectException
      Gets the indicator that determines whether steps can be created or deleted by team member. 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 TeamMemberStepsAddDeletable
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberStepsAddDeletable

      public void setTeamMemberStepsAddDeletable(boolean b) throws BusinessObjectException
      Sets the indicator that determines whether steps can be created or deleted by team member. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberCanUpdateNotebooks

      public boolean getTeamMemberCanUpdateNotebooks() throws BusinessObjectException
      Gets the indicator that determines whether notebooks can be updated by the team member. 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 TeamMemberCanUpdateNotebooks
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberCanUpdateNotebooks

      public void setTeamMemberCanUpdateNotebooks(boolean b) throws BusinessObjectException
      Sets the indicator that determines whether notebooks can be updated by the team member. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberAddNewActualUnits

      public boolean getTeamMemberAddNewActualUnits() throws BusinessObjectException
      Gets the indicator that determines whether team members enter new actual 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 TeamMemberAddNewActualUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberAddNewActualUnits

      public void setTeamMemberAddNewActualUnits(boolean b) throws BusinessObjectException
      Sets the indicator that determines whether team members enter new actual units. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberCanStatusOtherResources

      public boolean getTeamMemberCanStatusOtherResources() throws BusinessObjectException
      Gets the indicator that determines whether team member can status other resource assignments on an 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 TeamMemberCanStatusOtherResources
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberCanStatusOtherResources

      public void setTeamMemberCanStatusOtherResources(boolean b) throws BusinessObjectException
      Sets the indicator that determines whether team member can status other resource assignments on an activity. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberCanOutOfSequenceFlag

      public boolean getTeamMemberCanOutOfSequenceFlag() throws BusinessObjectException
      Gets the indicator that determines whether team member to check if activity is being pushed to out-of-sequence. 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 TeamMemberCanOutOfSequenceFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberCanOutOfSequenceFlag

      public void setTeamMemberCanOutOfSequenceFlag(boolean b) throws BusinessObjectException
      Sets the indicator that determines whether team member to check if activity is being pushed to out-of-sequence. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberDisplayPlannedUnits

      public boolean getTeamMemberDisplayPlannedUnits() throws BusinessObjectException
      Gets the indicator that determines whether team member will display planned units on activities and assignments or not. 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 TeamMemberDisplayPlannedUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberDisplayPlannedUnits

      public void setTeamMemberDisplayPlannedUnits(boolean b) throws BusinessObjectException
      Sets the indicator that determines whether team member will display planned units on activities and assignments or not. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberDisplayTotalFloatFlag

      public boolean getTeamMemberDisplayTotalFloatFlag() throws BusinessObjectException
      Gets the indicator that determines whether team member will display total float on my tasks and timesheets or not. 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 TeamMemberDisplayTotalFloatFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberDisplayTotalFloatFlag

      public void setTeamMemberDisplayTotalFloatFlag(boolean b) throws BusinessObjectException
      Sets the indicator that determines whether team member will display total float on my tasks and timesheets or not. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberDisplayBaselineDatesFlag

      public boolean getTeamMemberDisplayBaselineDatesFlag() throws BusinessObjectException
      Gets the indicator that determines whether team member will display project baseline dates on my tasks and timesheets or not. 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 TeamMemberDisplayBaselineDatesFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberDisplayBaselineDatesFlag

      public void setTeamMemberDisplayBaselineDatesFlag(boolean b) throws BusinessObjectException
      Sets the indicator that determines whether team member will display project baseline dates on my tasks and timesheets or not. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberDisplayDiscussionsFlag

      public boolean getTeamMemberDisplayDiscussionsFlag() throws BusinessObjectException
      Gets the indicator that determines whether team member will display discussion on my tasks and timesheets or not. 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 TeamMemberDisplayDiscussionsFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberDisplayDiscussionsFlag

      public void setTeamMemberDisplayDiscussionsFlag(boolean b) throws BusinessObjectException
      Sets the indicator that determines whether team member will display discussion on my tasks and timesheets or not. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberIncludePrimaryResources

      public boolean getTeamMemberIncludePrimaryResources() throws BusinessObjectException
      Gets primary Resource Flag determines if Team Members status their activities as Primary Resources too. 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 TeamMemberIncludePrimaryResources
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberIncludePrimaryResources

      public void setTeamMemberIncludePrimaryResources(boolean b) throws BusinessObjectException
      Sets primary Resource Flag determines if Team Members status their activities as Primary Resources too. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getOwnerResourceObjectId

      public ObjectId getOwnerResourceObjectId() throws BusinessObjectException
      Gets the unique ID of the Owner Resource of this project.
      Returns:
      the value in the field OwnerResourceObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setOwnerResourceObjectId

      public void setOwnerResourceObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the Owner Resource of this project.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getLinkPlannedAndAtCompletionFlag

      public boolean getLinkPlannedAndAtCompletionFlag() throws BusinessObjectException
      Gets the flag that indicates whether the At Completion Cost/Units should be linked to Planned Cost/Units for not-started activities. Default = 'true'.
      Returns:
      the value in the field LinkPlannedAndAtCompletionFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setLinkPlannedAndAtCompletionFlag

      public void setLinkPlannedAndAtCompletionFlag(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether the At Completion Cost/Units should be linked to Planned Cost/Units for not-started activities. Default = 'true'.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getResetPlannedToRemainingFlag

      public boolean getResetPlannedToRemainingFlag() throws BusinessObjectException
      Gets the flag that indicates whether to reset Planned Duration and Units to Remaining Duration and Units, or to reset Remaining Duration and Units to Planned Duration and Units when the Activity Status is or becomes not started. Default = 'true'.
      Returns:
      the value in the field ResetPlannedToRemainingFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setResetPlannedToRemainingFlag

      public void setResetPlannedToRemainingFlag(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether to reset Planned Duration and Units to Remaining Duration and Units, or to reset Remaining Duration and Units to Planned Duration and Units when the Activity Status is or becomes not started. Default = 'true'.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getAssignmentDefaultDrivingFlag

      public boolean getAssignmentDefaultDrivingFlag() throws BusinessObjectException
      Gets the default flag assigned to new assignments, to indicate whether assignments will drive activity dates.
      Returns:
      the value in the field AssignmentDefaultDrivingFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setAssignmentDefaultDrivingFlag

      public void setAssignmentDefaultDrivingFlag(boolean b) throws BusinessObjectException
      Sets the default flag assigned to new assignments, to indicate whether assignments will drive activity dates.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCurrentBaselineProjectObjectId

      public ObjectId getCurrentBaselineProjectObjectId() throws BusinessObjectException
      Gets the unique ID of the project's baseline to use for computing summaries. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field CurrentBaselineProjectObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setCurrentBaselineProjectObjectId

      public void setCurrentBaselineProjectObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the project's baseline to use for computing summaries. 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
    • getSourceProjectObjectId

      public ObjectId getSourceProjectObjectId() throws BusinessObjectException
      Gets the unique ID of the project from which the reflection project was created, if the current project is a reflection project.
      Returns:
      the value in the field SourceProjectObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getActivityDefaultCalendarObjectId

      public ObjectId getActivityDefaultCalendarObjectId() throws BusinessObjectException
      Gets the unique ID of the calendar assigned to new activities by default. Can be null for baselines. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field ActivityDefaultCalendarObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setActivityDefaultCalendarObjectId

      public void setActivityDefaultCalendarObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the calendar assigned to new activities by default. Can be null for baselines. 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
    • getActivityDefaultCalendarName

      public String getActivityDefaultCalendarName() throws BusinessObjectException
      Gets the name of the calendar assigned to new activities by default. Can be null for baselines.
      Returns:
      the value in the field ActivityDefaultCalendarName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getActivityDefaultCostAccountObjectId

      public ObjectId getActivityDefaultCostAccountObjectId() throws BusinessObjectException
      Gets the unique ID of the cost account assigned to new activities and project expenses by default.
      Returns:
      the value in the field ActivityDefaultCostAccountObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setActivityDefaultCostAccountObjectId

      public void setActivityDefaultCostAccountObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the cost account assigned to new activities and project expenses by default.
      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 Project 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 Project 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 Project element for identification. Each Project element is uniquely identified by this short code.
      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 Project element for identification. Each Project element is uniquely identified by this short code.
      Parameters:
      s - the value to set this field to
      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 Project. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field 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 Project. 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
    • 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
    • getContainsSummaryData

      public boolean getContainsSummaryData() throws BusinessObjectException
      Gets the flag that indicates that the Project has been summarized.
      Returns:
      the value in the field ContainsSummaryData
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getStatus

      public ProjectStatus getStatus() throws BusinessObjectException
      Gets the project status: 'Planned', 'Active', 'Inactive', 'What-If', 'Requested', or 'Template'.
      Returns:
      the value in the field Status
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setStatus

      public void setStatus(ProjectStatus enm) throws BusinessObjectException
      Sets the project status: 'Planned', 'Active', 'Inactive', 'What-If', 'Requested', or 'Template'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getIntegratedWBS

      public boolean getIntegratedWBS() throws BusinessObjectException
      Gets the indicator that determines whether a WBS is synchronized or not.
      Returns:
      the value in the field IntegratedWBS
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setIntegratedWBS

      public void setIntegratedWBS(boolean b) throws BusinessObjectException
      Sets the indicator that determines whether a WBS is synchronized or not.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getWBSCategoryObjectId

      public ObjectId getWBSCategoryObjectId() throws BusinessObjectException
      Gets the unique ID of the associated WBS category value. Note that the label used for the WBS category is dynamic; it is controlled by the system administrator.
      Returns:
      the value in the field WBSCategoryObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setWBSCategoryObjectId

      public void setWBSCategoryObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated WBS category value. Note that the label used for the WBS category is dynamic; it is controlled by the system administrator.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getReviewType

      public ReviewStatusType getReviewType() throws BusinessObjectException
      Gets review Type.
      Returns:
      the value in the field ReviewType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setReviewType

      public void setReviewType(ReviewStatusType enm) throws BusinessObjectException
      Sets review Type.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getDefaultPriceTimeUnits

      public UnitType getDefaultPriceTimeUnits() throws BusinessObjectException
      Gets the time units associated with the project's default price per time. Valid values are 'Hour', 'Day', 'Week', 'Month', and 'Year'.
      Returns:
      the value in the field DefaultPriceTimeUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setDefaultPriceTimeUnits

      public void setDefaultPriceTimeUnits(UnitType enm) throws BusinessObjectException
      Sets the time units associated with the project's default price per time. Valid values are 'Hour', 'Day', 'Week', 'Month', and 'Year'.
      Parameters:
      enm - the value to set this field to
      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
    • setIndependentETCTotalCost

      public void setIndependentETCTotalCost(Cost c) throws BusinessObjectException
      Sets the user-entered ETC total cost.
      Parameters:
      c - 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
    • setIndependentETCLaborUnits

      public void setIndependentETCLaborUnits(Unit u) throws BusinessObjectException
      Sets the user-entered ETC total labor.
      Parameters:
      u - the value to set this field to
      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
    • getStartDate

      public BeginDate getStartDate() throws BusinessObjectException
      Gets the start date of the project. This is a summary method calculated from fields populated by the Summarizer job service. 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 project. This is a summary method calculated from fields populated by the Summarizer job service. 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
    • getOverallProjectScore

      public int getOverallProjectScore() throws BusinessObjectException
      Gets the project score calculated based on all project code types assigned to this project. 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 OverallProjectScore
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getProjectSpread

      public ProjectSpread getProjectSpread() throws BusinessObjectException
      Gets the field containing spread data for this project. If a project is attempted to be loaded with spread data, getProjectSpread will return null if no spread data was available for that project. 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 ProjectSpread
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getProjectResourceSpreads

      public ProjectResourceSpread[] getProjectResourceSpreads() throws BusinessObjectException
      Gets the field containing resource spread data for this project. If a project is attempted to be loaded with resource spread data, getProjectResourceSpread will return null if no spread data was available for that project. 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 ProjectResourceSpread
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getResourceAssignmentCBSSpreads

      public ResourceAssignmentCBSSpread[] getResourceAssignmentCBSSpreads() throws BusinessObjectException
      Gets the field containing resource cbs spread data for this project. If a project is attempted to be loaded with resource cbs spread data, getResourceAssignmentCBSSpread will return null if no spread data was available for that project. 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 ResourceAssignmentCBSSpread
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getExpenseCategoryCBSSpreads

      public ExpenseCategoryCBSSpread[] getExpenseCategoryCBSSpreads() throws BusinessObjectException
      Gets the field containing expense category cbs spread data for this project. If a project is attempted to be loaded with expense category cbs spread data, getExpenseCategoryCBSSpread will return null if no spread data was available for that project. 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 ExpenseCategoryCBSSpread
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getProjectRoleSpreads

      public ProjectRoleSpread[] getProjectRoleSpreads() throws BusinessObjectException
      Gets the field containing role spread data for this project. If a project is attempted to be loaded with role spread data, getProjectRoleSpread will return null if no spread data was available for that project. 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 ProjectRoleSpread
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getAnticipatedFinishDate

      public EndDate getAnticipatedFinishDate() throws BusinessObjectException
      Gets the anticipated finish date of Project element. 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 Project element. 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 Project element. 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 Project element. 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
    • getEarnedValueComputeType

      public EarnedValueComputeType getEarnedValueComputeType() throws BusinessObjectException
      Gets the technique used for computing earned-value percent complete for activities within the Project. Valid values are 'Activity Percent Complete', '0 / 100', '50 / 50', 'Custom Percent Complete', 'WBS Milestones Percent Complete', and 'Activity Percent Complete Using Resource Curves'.
      Returns:
      the value in the field EarnedValueComputeType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setEarnedValueComputeType

      public void setEarnedValueComputeType(EarnedValueComputeType enm) throws BusinessObjectException
      Sets the technique used for computing earned-value percent complete for activities within the Project. Valid values are 'Activity Percent Complete', '0 / 100', '50 / 50', 'Custom Percent Complete', 'WBS Milestones Percent Complete', and 'Activity Percent Complete Using Resource Curves'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getEarnedValueETCComputeType

      public EarnedValueETCComputeType getEarnedValueETCComputeType() throws BusinessObjectException
      Gets the technique for computing earned-value estimate-to-complete for activities within the Project. Valid values are 'ETC = Remaining Cost for Activity', 'Performance Factor = 1', 'Performance Factor = Custom Value', 'Performance Factor = 1 / Cost Performance Index', and 'Performance Factor = 1 / (Cost Performance Index * Schedule Performance Index)'.
      Returns:
      the value in the field EarnedValueETCComputeType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setEarnedValueETCComputeType

      public void setEarnedValueETCComputeType(EarnedValueETCComputeType enm) throws BusinessObjectException
      Sets the technique for computing earned-value estimate-to-complete for activities within the Project. Valid values are 'ETC = Remaining Cost for Activity', 'Performance Factor = 1', 'Performance Factor = Custom Value', 'Performance Factor = 1 / Cost Performance Index', and 'Performance Factor = 1 / (Cost Performance Index * Schedule Performance Index)'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getEarnedValueETCUserValue

      public double getEarnedValueETCUserValue() throws BusinessObjectException
      Gets the user-defined performance factor, PF, for computing earned-value estimate-to-complete. ETC is computed as PF * (BAC - earned value).
      Returns:
      the value in the field EarnedValueETCUserValue
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setEarnedValueETCUserValue

      public void setEarnedValueETCUserValue(double d) throws BusinessObjectException
      Sets the user-defined performance factor, PF, for computing earned-value estimate-to-complete. ETC is computed as PF * (BAC - earned value).
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getEarnedValueUserPercent

      public Percent getEarnedValueUserPercent() throws BusinessObjectException
      Gets the user-defined percent complete for computing earned value for activities within the Project. A value of, say, 25 means that 25% of the planned amount is earned when the activity is started and the remainder is earned when the activity is completed.
      Returns:
      the value in the field EarnedValueUserPercent
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setEarnedValueUserPercent

      public void setEarnedValueUserPercent(Percent p) throws BusinessObjectException
      Sets the user-defined percent complete for computing earned value for activities within the Project. A value of, say, 25 means that 25% of the planned amount is earned when the activity is started and the remainder is earned when the activity is completed.
      Parameters:
      p - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getDataDate

      public Date getDataDate() throws BusinessObjectException
      Gets the current data date for the project. The project status is up to date as of the data date. The data date is modified when project actuals are applied. 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 DataDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setDataDate

      public void setDataDate(Date d) throws BusinessObjectException
      Sets the current data date for the project. The project status is up to date as of the data date. The data date is modified when project actuals are applied. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      d - the value to set this field to
      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
    • setPlannedStartDate

      public void setPlannedStartDate(BeginDate d) throws BusinessObjectException
      Sets the planned start date of the project. Used by the project scheduler.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getMustFinishByDate

      public EndDate getMustFinishByDate() throws BusinessObjectException
      Gets the date by which all project activities must finish. If entered, it is used as the project late finish date by the project scheduler.
      Returns:
      the value in the field MustFinishByDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setMustFinishByDate

      public void setMustFinishByDate(EndDate d) throws BusinessObjectException
      Sets the date by which all project activities must finish. If entered, it is used as the project late finish date by the project scheduler.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getProjectForecastStartDate

      public BeginDate getProjectForecastStartDate() throws BusinessObjectException
      Gets the alternate start date to be optionally used by the scheduler. The user sets the alternate start date by dragging the project bar in the Gantt Chart around while manually leveling the resource profile in a resource analysis layout.
      Returns:
      the value in the field ProjectForecastStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setProjectForecastStartDate

      public void setProjectForecastStartDate(BeginDate d) throws BusinessObjectException
      Sets the alternate start date to be optionally used by the scheduler. The user sets the alternate start date by dragging the project bar in the Gantt Chart around while manually leveling the resource profile in a resource analysis layout.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getScheduledFinishDate

      public EndDate getScheduledFinishDate() throws BusinessObjectException
      Gets the early finish date of the latest activity in the project, as computed by the project scheduler.
      Returns:
      the value in the field ScheduledFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setScheduledFinishDate

      public void setScheduledFinishDate(EndDate d) throws BusinessObjectException
      Sets the early finish date of the latest activity in the project, as computed by the project scheduler.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getActivityIdBasedOnSelectedActivity

      public boolean getActivityIdBasedOnSelectedActivity() throws BusinessObjectException
      Gets the flag that indicates how to auto-number activity IDs for new activities-Y/N - Y means use the selected activity's activity ID as prefix, N means use standard auto-numbering based on the prefix, suffix. Default = 'false'.
      Returns:
      the value in the field ActivityIdBasedOnSelectedActivity
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setActivityIdBasedOnSelectedActivity

      public void setActivityIdBasedOnSelectedActivity(boolean b) throws BusinessObjectException
      Sets the flag that indicates how to auto-number activity IDs for new activities-Y/N - Y means use the selected activity's activity ID as prefix, N means use standard auto-numbering based on the prefix, suffix. Default = 'false'.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getAddedBy

      public String getAddedBy() throws BusinessObjectException
      Gets the name of the user who added the project to the database.
      Returns:
      the value in the field AddedBy
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setAddedBy

      public void setAddedBy(String s) throws BusinessObjectException
      Sets the name of the user who added the project to the database.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getDateAdded

      public Date getDateAdded() throws BusinessObjectException
      Gets the date on which the project was added to the Project Management database.
      Returns:
      the value in the field DateAdded
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setDateAdded

      public void setDateAdded(Date d) throws BusinessObjectException
      Sets the date on which the project was added to the Project Management database.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCostQuantityRecalculateFlag

      public boolean getCostQuantityRecalculateFlag() throws BusinessObjectException
      Gets the flag that, when costs and quantities are linked, indicates whether the quantities should be updated when costs are updated,.
      Returns:
      the value in the field CostQuantityRecalculateFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setCostQuantityRecalculateFlag

      public void setCostQuantityRecalculateFlag(boolean b) throws BusinessObjectException
      Sets the flag that, when costs and quantities are linked, indicates whether the quantities should be updated when costs are updated,.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getLinkPercentCompleteWithActual

      public boolean getLinkPercentCompleteWithActual() throws BusinessObjectException
      Gets the flag that indicates whether actual units and cost should be recalculated when percent complete changes. Default = 'false'.
      Returns:
      the value in the field LinkPercentCompleteWithActual
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setLinkPercentCompleteWithActual

      public void setLinkPercentCompleteWithActual(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether actual units and cost should be recalculated when percent complete changes. Default = 'false'.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getLevelingPriority

      public int getLevelingPriority() throws BusinessObjectException
      Gets the priority for scheduling.
      Returns:
      the value in the field LevelingPriority
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setLevelingPriority

      public void setLevelingPriority(int i) throws BusinessObjectException
      Sets the priority for scheduling.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getWebSiteURL

      public String getWebSiteURL() throws BusinessObjectException
      Gets the project Web site URL, which is the Web address of the project's website.
      Returns:
      the value in the field WebSiteURL
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setWebSiteURL

      public void setWebSiteURL(String s) throws BusinessObjectException
      Sets the project Web site URL, which is the Web address of the project's website.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getAssignmentDefaultRateType

      public DefaultRateType getAssignmentDefaultRateType() throws BusinessObjectException
      Gets the default rate type when adding resource assignments to a project. Valid values are 'Price / Unit', 'Price / Unit2', 'Price / Unit3', 'Price / Unit4', and 'Price / Unit5'.
      Returns:
      the value in the field AssignmentDefaultRateType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setAssignmentDefaultRateType

      public void setAssignmentDefaultRateType(DefaultRateType enm) throws BusinessObjectException
      Sets the default rate type when adding resource assignments to a project. Valid values are 'Price / Unit', 'Price / Unit2', 'Price / Unit3', 'Price / Unit4', and 'Price / Unit5'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getRiskScore

      public int getRiskScore() throws BusinessObjectException
      Gets the calculated risk score for the project. 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 RiskScore
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getRiskExposure

      public Cost getRiskExposure() throws BusinessObjectException
      Gets the calculated exposure value for the project. 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 RiskExposure
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getRiskLevel

      public ProjectRiskLevel getRiskLevel() throws BusinessObjectException
      Gets the risk level assigned to the project: 'Very High', 'High', 'Medium', 'Low', and 'Very Low'. 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 RiskLevel
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setRiskLevel

      public void setRiskLevel(ProjectRiskLevel enm) throws BusinessObjectException
      Sets the risk level assigned to the project: 'Very High', 'High', 'Medium', 'Low', and 'Very Low'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getStrategicPriority

      public int getStrategicPriority() throws BusinessObjectException
      Gets the project's priority. The range is from 1 to 10,000.
      Returns:
      the value in the field StrategicPriority
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setStrategicPriority

      public void setStrategicPriority(int i) throws BusinessObjectException
      Sets the project's priority. The range is from 1 to 10,000.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getWebSiteRootDirectory

      public String getWebSiteRootDirectory() throws BusinessObjectException
      Gets the root directory for storing project Web site files before they are published to the Web server.
      Returns:
      the value in the field WebSiteRootDirectory
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setWebSiteRootDirectory

      public void setWebSiteRootDirectory(String s) throws BusinessObjectException
      Sets the root directory for storing project Web site files before they are published to the Web server.
      Parameters:
      s - the value to set this field to
      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
    • getSummarizedDataDate

      public Date getSummarizedDataDate() throws BusinessObjectException
      Gets the data date of the project when it was last summarized-only updated by summarizer.
      Returns:
      the value in the field SummarizedDataDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setSummarizedDataDate

      public void setSummarizedDataDate(Date d) throws BusinessObjectException
      Sets the data date of the project when it was last summarized-only updated by summarizer.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getEnablePublication

      public boolean getEnablePublication() throws BusinessObjectException
      Gets enables the project to be processed by the Project Arbiter service.
      Returns:
      the value in the field EnablePublication
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setEnablePublication

      public void setEnablePublication(boolean b) throws BusinessObjectException
      Sets enables the project to be processed by the Project Arbiter service.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getEnableSummarization

      public boolean getEnableSummarization() throws BusinessObjectException
      Gets the option which, when true, directs the Summarizer service to automatically summarize the project. If this is false, the project will be skipped during the summary run.
      Returns:
      the value in the field EnableSummarization
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setEnableSummarization

      public void setEnableSummarization(boolean b) throws BusinessObjectException
      Sets the option which, when true, directs the Summarizer service to automatically summarize the project. If this is false, the project will be skipped during the summary run.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCheckOutStatus

      public boolean getCheckOutStatus() throws BusinessObjectException
      Gets the flag that indicates that the project is currently checked out to an external file or database and is being managed remotely.
      Returns:
      the value in the field CheckOutStatus
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setCheckOutStatus

      public void setCheckOutStatus(boolean b) throws BusinessObjectException
      Sets the flag that indicates that the project is currently checked out to an external file or database and is being managed remotely.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getActivityDefaultDurationType

      public DurationType getActivityDefaultDurationType() throws BusinessObjectException
      Gets the duration type assigned to new activities by default. Valid values are 'Fixed Units/Time', 'Fixed Duration and Units/Time', 'Fixed Units', or 'Fixed Duration and Units'.
      Returns:
      the value in the field ActivityDefaultDurationType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setActivityDefaultDurationType

      public void setActivityDefaultDurationType(DurationType enm) throws BusinessObjectException
      Sets the duration type assigned to new activities by default. Valid values are 'Fixed Units/Time', 'Fixed Duration and Units/Time', 'Fixed Units', or 'Fixed Duration and Units'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getActivityDefaultPercentCompleteType

      public PercentCompleteType getActivityDefaultPercentCompleteType() throws BusinessObjectException
      Gets the percent complete type assigned to new activities by default. Valid values are 'Physical', 'Duration', and 'Units'.
      Returns:
      the value in the field ActivityDefaultPercentCompleteType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setActivityDefaultPercentCompleteType

      public void setActivityDefaultPercentCompleteType(PercentCompleteType enm) throws BusinessObjectException
      Sets the percent complete type assigned to new activities by default. Valid values are 'Physical', 'Duration', and 'Units'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getActivityDefaultActivityType

      public ActivityType getActivityDefaultActivityType() throws BusinessObjectException
      Gets the default type for activities. Possible values are 'Task Dependent', 'Resource Dependent', 'Level of Effort', or 'Milestone'. A 'Task Dependent' activity is scheduled using the activity's calendar rather than the calendars of the assigned resources. A 'Resource Dependent' activity is scheduled using the calendars of the assigned resources. This type is used when several resources are assigned to the activity, but they may work separately. A 'Milestone' is a zero-duration activity without resources, marking a significant project event. A 'Level of Effort' activity has a duration that is determined by its dependent activities. Administration-type activities are typically 'Level of Effort'.
      Returns:
      the value in the field ActivityDefaultActivityType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setActivityDefaultActivityType

      public void setActivityDefaultActivityType(ActivityType enm) throws BusinessObjectException
      Sets the default type for activities. Possible values are 'Task Dependent', 'Resource Dependent', 'Level of Effort', or 'Milestone'. A 'Task Dependent' activity is scheduled using the activity's calendar rather than the calendars of the assigned resources. A 'Resource Dependent' activity is scheduled using the calendars of the assigned resources. This type is used when several resources are assigned to the activity, but they may work separately. A 'Milestone' is a zero-duration activity without resources, marking a significant project event. A 'Level of Effort' activity has a duration that is determined by its dependent activities. Administration-type activities are typically 'Level of Effort'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getActivityIdPrefix

      public String getActivityIdPrefix() throws BusinessObjectException
      Gets the prefix used for auto-numbering of activity IDs. When a new activity is created, the activity ID is automatically generated using auto-numbering. Activity ID auto-numbering concatenates the prefix and the suffix, with the suffix incremented to make the code unique. Example: 'A', '1000', '10' yields activity IDs of 'A1010', 'A1020', 'A1030', etc.
      Returns:
      the value in the field ActivityIdPrefix
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setActivityIdPrefix

      public void setActivityIdPrefix(String s) throws BusinessObjectException
      Sets the prefix used for auto-numbering of activity IDs. When a new activity is created, the activity ID is automatically generated using auto-numbering. Activity ID auto-numbering concatenates the prefix and the suffix, with the suffix incremented to make the code unique. Example: 'A', '1000', '10' yields activity IDs of 'A1010', 'A1020', 'A1030', etc.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getActivityIdSuffix

      public int getActivityIdSuffix() throws BusinessObjectException
      Gets the suffix used for auto-numbering of activity IDs. When a new activity is created, the activity ID is automatically generated using auto-numbering. Activity ID auto-numbering concatenates the prefix and the suffix, with the suffix incremented to make the code unique. Example: 'A', '1000', '10' yields activity IDs of 'A1010', 'A1020', 'A1030', etc.
      Returns:
      the value in the field ActivityIdSuffix
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setActivityIdSuffix

      public void setActivityIdSuffix(int i) throws BusinessObjectException
      Sets the suffix used for auto-numbering of activity IDs. When a new activity is created, the activity ID is automatically generated using auto-numbering. Activity ID auto-numbering concatenates the prefix and the suffix, with the suffix incremented to make the code unique. Example: 'A', '1000', '10' yields activity IDs of 'A1010', 'A1020', 'A1030', etc.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getActivityIdIncrement

      public int getActivityIdIncrement() throws BusinessObjectException
      Gets the increment used for auto-numbering of activity IDs. When a new activity is created, the activity ID is automatically generated using auto-numbering. Activity ID auto-numbering concatenates the prefix and the suffix, with the suffix incremented to make the code unique. Example: 'A', '1000', '10' yields activity IDs of 'A1010', 'A1020', 'A1030', etc.
      Returns:
      the value in the field ActivityIdIncrement
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setActivityIdIncrement

      public void setActivityIdIncrement(int i) throws BusinessObjectException
      Sets the increment used for auto-numbering of activity IDs. When a new activity is created, the activity ID is automatically generated using auto-numbering. Activity ID auto-numbering concatenates the prefix and the suffix, with the suffix incremented to make the code unique. Example: 'A', '1000', '10' yields activity IDs of 'A1010', 'A1020', 'A1030', etc.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getResourceCanBeAssignedToSameActivityMoreThanOnce

      public boolean getResourceCanBeAssignedToSameActivityMoreThanOnce() throws BusinessObjectException
      Gets the flag that indicates whether a resource can be assigned more than once to the same activity. This is useful when the resource is expected to perform more than one role on an activity, for example, documentation plus QA.
      Returns:
      the value in the field ResourceCanBeAssignedToSameActivityMoreThanOnce
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setResourceCanBeAssignedToSameActivityMoreThanOnce

      public void setResourceCanBeAssignedToSameActivityMoreThanOnce(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether a resource can be assigned more than once to the same activity. This is useful when the resource is expected to perform more than one role on an activity, for example, documentation plus QA.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getPrimaryResourcesCanMarkActivitiesAsCompleted

      public boolean getPrimaryResourcesCanMarkActivitiesAsCompleted() throws BusinessObjectException
      Gets the flag that indicates whether primary resources can mark the project activities as completed. If not selected, a primary resource can only mark an activity as For Review. In this case the project manager reviews the activity and marks it as either Rejected or completed.
      Returns:
      the value in the field PrimaryResourcesCanMarkActivitiesAsCompleted
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setPrimaryResourcesCanMarkActivitiesAsCompleted

      public void setPrimaryResourcesCanMarkActivitiesAsCompleted(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether primary resources can mark the project activities as completed. If not selected, a primary resource can only mark an activity as For Review. In this case the project manager reviews the activity and marks it as either Rejected or completed.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getPrimaryResourcesCanUpdateActivityDates

      public boolean getPrimaryResourcesCanUpdateActivityDates() throws BusinessObjectException
      Gets the flag that indicates whether primary resources can update the activity level dates in team member application.
      Returns:
      the value in the field PrimaryResourcesCanUpdateActivityDates
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setPrimaryResourcesCanUpdateActivityDates

      public void setPrimaryResourcesCanUpdateActivityDates(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether primary resources can update the activity level dates in team member application.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getResourcesCanAssignThemselvesToActivities

      public boolean getResourcesCanAssignThemselvesToActivities() throws BusinessObjectException
      Gets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project.
      Returns:
      the value in the field ResourcesCanAssignThemselvesToActivities
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setResourcesCanAssignThemselvesToActivities

      public void setResourcesCanAssignThemselvesToActivities(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getResourcesCanAssignThemselvesToActivitiesOutsideOBSAccess

      public boolean getResourcesCanAssignThemselvesToActivitiesOutsideOBSAccess() throws BusinessObjectException
      Gets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project outside Resource Manager access.
      Returns:
      the value in the field ResourcesCanAssignThemselvesToActivitiesOutsideOBSAccess
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setResourcesCanAssignThemselvesToActivitiesOutsideOBSAccess

      public void setResourcesCanAssignThemselvesToActivitiesOutsideOBSAccess(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project outside Resource Manager access.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getResourcesCanStaffRoleAssignment

      public boolean getResourcesCanStaffRoleAssignment() throws BusinessObjectException
      Gets the flag that indicates whether team-member application users are allowed to staff themselves to role assignment in this project.
      Returns:
      the value in the field ResourcesCanStaffRoleAssignment
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setResourcesCanStaffRoleAssignment

      public void setResourcesCanStaffRoleAssignment(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether team-member application users are allowed to staff themselves to role assignment in this project.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberAssignmentProficiencyFlag

      public boolean getTeamMemberAssignmentProficiencyFlag() throws BusinessObjectException
      Gets the indicator that determines whether to use role assignment proficiency or resource's role proficiency. 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 TeamMemberAssignmentProficiencyFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberAssignmentProficiencyFlag

      public void setTeamMemberAssignmentProficiencyFlag(boolean b) throws BusinessObjectException
      Sets the indicator that determines whether to use role assignment proficiency or resource's role proficiency. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getUnitPerTimeOvertimeFactor

      public String getUnitPerTimeOvertimeFactor() throws BusinessObjectException
      Gets field that specify to use role or resource unitPerTime and overtime factor. 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 UnitPerTimeOvertimeFactor
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setUnitPerTimeOvertimeFactor

      public void setUnitPerTimeOvertimeFactor(String s) throws BusinessObjectException
      Sets field that specify to use role or resource unitPerTime and overtime factor. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getPricePerUnit

      public String getPricePerUnit() throws BusinessObjectException
      Gets field that specify whether to use role or resource price per unit. 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 PricePerUnit
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setPricePerUnit

      public void setPricePerUnit(String s) throws BusinessObjectException
      Sets field that specify whether to use role or resource price per unit. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getResourcesCanEditAssignmentPercentComplete

      public boolean getResourcesCanEditAssignmentPercentComplete() throws BusinessObjectException
      Gets the flag that indicates whether the project's resource update the remaining units or the percent complete for their activities in the timesheet application.
      Returns:
      the value in the field ResourcesCanEditAssignmentPercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setResourcesCanEditAssignmentPercentComplete

      public void setResourcesCanEditAssignmentPercentComplete(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether the project's resource update the remaining units or the percent complete for their activities in the timesheet application.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getResourcesCanMarkAssignmentAsCompleted

      public boolean getResourcesCanMarkAssignmentAsCompleted() throws BusinessObjectException
      Gets the flag that indicates whether timesheet resources can mark the assignment as complete.
      Returns:
      the value in the field ResourcesCanMarkAssignmentAsCompleted
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setResourcesCanMarkAssignmentAsCompleted

      public void setResourcesCanMarkAssignmentAsCompleted(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether timesheet resources can mark the assignment as complete.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getResourcesCanViewInactiveActivities

      public boolean getResourcesCanViewInactiveActivities() throws BusinessObjectException
      Gets the flag that indicates whether timesheet resources can view inactive project activities.
      Returns:
      the value in the field ResourcesCanViewInactiveActivities
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setResourcesCanViewInactiveActivities

      public void setResourcesCanViewInactiveActivities(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether timesheet resources can view inactive project activities.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getAnnualDiscountRate

      public double getAnnualDiscountRate() throws BusinessObjectException
      Gets the user-defined number field that identifies the discount rate for the project.
      Returns:
      the value in the field AnnualDiscountRate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setAnnualDiscountRate

      public void setAnnualDiscountRate(double d) throws BusinessObjectException
      Sets the user-defined number field that identifies the discount rate for the project.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getDiscountApplicationPeriod

      public DiscountApplicationPeriod getDiscountApplicationPeriod() throws BusinessObjectException
      Gets the timescale for entering ROI spending and benefit plan. Valid values are 'Month', 'Quarter', or 'Year'.
      Returns:
      the value in the field DiscountApplicationPeriod
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setDiscountApplicationPeriod

      public void setDiscountApplicationPeriod(DiscountApplicationPeriod enm) throws BusinessObjectException
      Sets the timescale for entering ROI spending and benefit plan. Valid values are 'Month', 'Quarter', or 'Year'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummarizeToWBSLevel

      public int getSummarizeToWBSLevel() throws BusinessObjectException
      Gets the maximum level within the project's WBS to perform summarization - default to 2.
      Returns:
      the value in the field SummarizeToWBSLevel
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setSummarizeToWBSLevel

      public void setSummarizeToWBSLevel(int i) throws BusinessObjectException
      Sets the maximum level within the project's WBS to perform summarization - default to 2.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryLevel

      public SummaryLevel getSummaryLevel() throws BusinessObjectException
      Gets the summary level for the project while performing project summarization. Valid values are "WBS Level" and "Assignment Level".
      Returns:
      the value in the field SummaryLevel
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setSummaryLevel

      public void setSummaryLevel(SummaryLevel enm) throws BusinessObjectException
      Sets the summary level for the project while performing project summarization. Valid values are "WBS Level" and "Assignment Level".
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getPublishLevel

      public SummaryLevel getPublishLevel() throws BusinessObjectException
      Gets the publish level for the project publication.
      Returns:
      the value in the field PublishLevel
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setPublishLevel

      public void setPublishLevel(SummaryLevel enm) throws BusinessObjectException
      Sets the publish level for the project publication.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getWBSCodeSeparator

      public String getWBSCodeSeparator() throws BusinessObjectException
      Gets the character used to separate the concatenated code fields for the project's WBS tree.
      Returns:
      the value in the field WBSCodeSeparator
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setWBSCodeSeparator

      public void setWBSCodeSeparator(String s) throws BusinessObjectException
      Sets the character used to separate the concatenated code fields for the project's WBS tree.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getFiscalYearStartMonth

      public int getFiscalYearStartMonth() throws BusinessObjectException
      Gets the month that marks the beginning of the fiscal year for the project.
      Returns:
      the value in the field FiscalYearStartMonth
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setFiscalYearStartMonth

      public void setFiscalYearStartMonth(int i) throws BusinessObjectException
      Sets the month that marks the beginning of the fiscal year for the project.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCriticalActivityFloatLimit

      public Duration getCriticalActivityFloatLimit() throws BusinessObjectException
      Gets the duration used to determine if an activity is critical. When an activity has total float that is less than or equal to this duration, the activity is marked as critical.
      Returns:
      the value in the field CriticalActivityFloatLimit
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setCriticalActivityFloatLimit

      public void setCriticalActivityFloatLimit(Duration d) throws BusinessObjectException
      Sets the duration used to determine if an activity is critical. When an activity has total float that is less than or equal to this duration, the activity is marked as critical.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCriticalActivityPathType

      public CriticalActivityPathType getCriticalActivityPathType() throws BusinessObjectException
      Gets the critical path type, which indicates how critical path activities are identified for the project, based on either 'Critical Float' or 'Longest Path'.
      Returns:
      the value in the field CriticalActivityPathType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setCriticalActivityPathType

      public void setCriticalActivityPathType(CriticalActivityPathType enm) throws BusinessObjectException
      Sets the critical path type, which indicates how critical path activities are identified for the project, based on either 'Critical Float' or 'Longest Path'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getActivityPercentCompleteBasedOnActivitySteps

      public boolean getActivityPercentCompleteBasedOnActivitySteps() throws BusinessObjectException
      Gets the flag that indicates whether activity physical percent complete is automatically computed from the activity steps completed.
      Returns:
      the value in the field ActivityPercentCompleteBasedOnActivitySteps
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setActivityPercentCompleteBasedOnActivitySteps

      public void setActivityPercentCompleteBasedOnActivitySteps(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether activity physical percent complete is automatically computed from the activity steps completed.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getActivityDefaultPricePerUnit

      public Cost getActivityDefaultPricePerUnit() throws BusinessObjectException
      Gets the price used to estimate resource costs for activities that have planned, actual, or remaining units, but no resource assignments. This price is also used to compute costs for activities in cases where resources are assigned but the resources have no prices. Resource cost is computed as the resource units multiplied by the price per time.
      Returns:
      the value in the field ActivityDefaultPricePerUnit
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setActivityDefaultPricePerUnit

      public void setActivityDefaultPricePerUnit(Cost c) throws BusinessObjectException
      Sets the price used to estimate resource costs for activities that have planned, actual, or remaining units, but no resource assignments. This price is also used to compute costs for activities in cases where resources are assigned but the resources have no prices. Resource cost is computed as the resource units multiplied by the price per time.
      Parameters:
      c - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getAddActualToRemaining

      public boolean getAddActualToRemaining() throws BusinessObjectException
      Gets the flag that indicates whether to add actual to remaining or to subtract actual from at complete when actual units and costs are updated. Default = 'true'.
      Returns:
      the value in the field AddActualToRemaining
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setAddActualToRemaining

      public void setAddActualToRemaining(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether to add actual to remaining or to subtract actual from at complete when actual units and costs are updated. Default = 'true'.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getLinkActualToActualThisPeriod

      public boolean getLinkActualToActualThisPeriod() throws BusinessObjectException
      Gets the flag that indicates whether actual units and costs are linked to actual-this-period units and costs. Setting this field to true asynchronously causes all actual-this-period values to be recalculated for the project via a job service. Default = 'true'.
      Returns:
      the value in the field LinkActualToActualThisPeriod
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setLinkActualToActualThisPeriod

      public void setLinkActualToActualThisPeriod(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether actual units and costs are linked to actual-this-period units and costs. Setting this field to true asynchronously causes all actual-this-period values to be recalculated for the project via a job service. Default = 'true'.
      Parameters:
      b - the value to set this field to
      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
    • 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
    • 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 project. 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 portion of the baseline labor units that is actually completed as of the project data date. Computed as Baseline Labor Units * Performance % Complete. The planned labor units performed is essentially the labor units Earned Value for the activity. The method for computing the Performance % Complete depends on the Earned Value technique selected for the activity's WBS. 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 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 Project. 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 Project 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 project 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 Project 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 percent complete of the activity duration. Computed as (planned duration - remaining duration) / planned duration * 100. The planned duration is taken from the current plan, not from 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 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 Project.). 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 project. 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 Project. 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
    • getForecastStartDate

      public BeginDate getForecastStartDate() throws BusinessObjectException
      Gets the alternate start date to be optionally used by the scheduler. The user sets the alternate start date by dragging the project bar in the Gantt Chart around while manually leveling the resource profile in a resource analysis layout. 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 ForecastStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getForecastFinishDate

      public EndDate getForecastFinishDate() throws BusinessObjectException
      Gets the alternate end date to be optionally used by the scheduler. The user sets the alternate end date by dragging the project bar in the Gantt Chart while manually leveling the resource profile in a resource analysis layout. 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 ForecastFinishDate
      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 Project. 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 Project. 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 project. 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 Project. 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 Project. 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 Project. 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 Project. 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 Project. 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 planned 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 Project. 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 in-progress 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 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 Project 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 Project 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 Project 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
    • 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
    • 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
    • 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
    • getSummaryNonLaborUnitsPercentComplete

      public Percent getSummaryNonLaborUnitsPercentComplete() throws BusinessObjectException
      Gets the percent complete of units for all nonlabor resources for the Project. 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
    • getCheckOutDate

      public Date getCheckOutDate() throws BusinessObjectException
      Gets the date on which the project was checked out of the Project Management database.
      Returns:
      the value in the field CheckOutDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCheckOutUserObjectId

      public ObjectId getCheckOutUserObjectId() throws BusinessObjectException
      Gets the unique ID of the User that checked out this project.
      Returns:
      the value in the field CheckOutUserObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCheckedOutModule

      public String getCheckedOutModule() throws BusinessObjectException
      Gets the module from which the user has checked out.
      Returns:
      the value in the field CheckedOutModule
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setCheckedOutModule

      public void setCheckedOutModule(String s) throws BusinessObjectException
      Sets the module from which the user has checked out.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getLastFinancialPeriodObjectId

      public ObjectId getLastFinancialPeriodObjectId() throws BusinessObjectException
      Gets the unique ID of the last closed financial period for the project.
      Returns:
      the value in the field LastFinancialPeriodObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setLastFinancialPeriodObjectId

      public void setLastFinancialPeriodObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the last closed financial period for the project.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCreateDate

      public Date getCreateDate() throws BusinessObjectException
      Gets the date this project 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 project was last updated.
      Returns:
      the value in the field LastUpdateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getLastPublishedOn

      public Date getLastPublishedOn() throws BusinessObjectException
      Gets the date the project was last published.
      Returns:
      the value in the field LastPublishedOn
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getPublicationPriority

      public int getPublicationPriority() throws BusinessObjectException
      Gets a priority value the Project Arbiter service uses to determine the order in which projects are submitted to the service queue, where 1 is highest priority and 100 is lowest priority.
      Returns:
      the value in the field PublicationPriority
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setPublicationPriority

      public void setPublicationPriority(int i) throws BusinessObjectException
      Sets a priority value the Project Arbiter service uses to determine the order in which projects are submitted to the service queue, where 1 is highest priority and 100 is lowest priority.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getLastLevelDate

      public Date getLastLevelDate() throws BusinessObjectException
      Gets the date the project was last leveled.
      Returns:
      the value in the field LastLevelDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getLastScheduleDate

      public Date getLastScheduleDate() throws BusinessObjectException
      Gets the date the project was last scheduled.
      Returns:
      the value in the field LastScheduleDate
      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 project.
      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 project.
      Returns:
      the value in the field LastUpdateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getUseProjectBaselineForEarnedValue

      public boolean getUseProjectBaselineForEarnedValue() throws BusinessObjectException
      Gets the flag that indicates whether earned value should be calculated based on the project baseline or the user's primary baseline. This setting only affects Project Management, not the Integration API or Primavera's Web application.
      Returns:
      the value in the field UseProjectBaselineForEarnedValue
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setUseProjectBaselineForEarnedValue

      public void setUseProjectBaselineForEarnedValue(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether earned value should be calculated based on the project baseline or the user's primary baseline. This setting only affects Project Management, not the Integration API or Primavera's Web application.
      Parameters:
      b - the value to set this field to
      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 project. 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 project. 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 project. 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 project. 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 project. 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
    • getAllowNegativeActualUnitsFlag

      public boolean getAllowNegativeActualUnitsFlag() throws BusinessObjectException
      Gets the flag that indicates whether the project can allow the negative valus for the actual units.
      Returns:
      the value in the field AllowNegativeActualUnitsFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setAllowNegativeActualUnitsFlag

      public void setAllowNegativeActualUnitsFlag(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether the project can allow the negative valus for the actual units.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getLastApplyActualsDate

      public Date getLastApplyActualsDate() throws BusinessObjectException
      Gets the last date Apply Actuals was run for this project.
      Returns:
      the value in the field LastApplyActualsDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummaryCostPercentComplete

      public Percent getSummaryCostPercentComplete() throws BusinessObjectException
      Gets the percent complete of cost for all nonlabor resources assigned. 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 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 Project. 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 project. 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 project. 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 project. 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 project. 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 project. 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 project. 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 project. 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 project. 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 project. 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 project. 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
    • getHasFutureBucketData

      public boolean getHasFutureBucketData() throws BusinessObjectException
      Gets the flag that indicates whether a resource assignment in the project has future bucket data. 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 HasFutureBucketData
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getIntegratedType

      public IntegratedProjectType getIntegratedType() throws BusinessObjectException
      Gets the flag indicating whether the project is integrated with an Enterprise Resource Planning (ERP) system. 'Fusion' indicates the project is integrated with Oracle Fusion. 'ERP' indicates the project is integrated with another ERP system.
      Returns:
      the value in the field IntegratedType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setIntegratedType

      public void setIntegratedType(IntegratedProjectType enm) throws BusinessObjectException
      Sets the flag indicating whether the project is integrated with an Enterprise Resource Planning (ERP) system. 'Fusion' indicates the project is integrated with Oracle Fusion. 'ERP' indicates the project is integrated with another ERP system.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getDescription

      public String getDescription() throws BusinessObjectException
      Gets the description of the Project.
      Returns:
      the value in the field Description
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setDescription

      public void setDescription(String s) throws BusinessObjectException
      Sets the description of the Project.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getIsTemplate

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

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

      public void setRiskMatrixObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated Risk Matrix. 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
    • getRiskMatrixName

      public String getRiskMatrixName() throws BusinessObjectException
      Gets the name of the risk matrix.
      Returns:
      the value in the field RiskMatrixName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getWBSMilestonePercentComplete

      public Percent getWBSMilestonePercentComplete() throws BusinessObjectException
      Gets the WBSMilestonePercentComplete field determines whether to calculate earned value by defining milestones at the WBS level and assigning a level of significance or weight to each of them. As progress occurs and you mark each milestone complete, the WBS element's performance percent complete is calculated based on the weight of the milestone. 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 WBSMilestonePercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getNetPresentValue

      public Cost getNetPresentValue() throws BusinessObjectException
      Gets the estimated net value, at the present time for the project. 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 NetPresentValue
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getReturnOnInvestment

      public Percent getReturnOnInvestment() throws BusinessObjectException
      Gets the estimated return on investment for the project. 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 ReturnOnInvestment
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getPaybackPeriod

      public int getPaybackPeriod() throws BusinessObjectException
      Gets the PaybackPeriod for the project. 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 PaybackPeriod
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getContractManagementGroupName

      public String getContractManagementGroupName() throws BusinessObjectException
      Gets the name of the Contract Management Group. 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 ContractManagementGroupName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setContractManagementGroupName

      public void setContractManagementGroupName(String s) throws BusinessObjectException
      Sets the name of the Contract Management Group. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getContractManagementProjectName

      public String getContractManagementProjectName() throws BusinessObjectException
      Gets the name of the Contract Management Project. 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 ContractManagementProjectName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setContractManagementProjectName

      public void setContractManagementProjectName(String s) throws BusinessObjectException
      Sets the name of the Contract Management Project. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getLocationObjectId

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

      public void setLocationObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the location assigned to the project. 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
    • getLocationName

      public String getLocationName() throws BusinessObjectException
      Gets the name of the location assigned to the project.
      Returns:
      the value in the field LocationName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getLongitude

      public double getLongitude() throws BusinessObjectException
      Gets the longitude of the location.
      Returns:
      the value in the field Longitude
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getLatitude

      public double getLatitude() throws BusinessObjectException
      Gets the latitude of the location.
      Returns:
      the value in the field Latitude
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSummarizeResourcesRolesByWBS

      public boolean getSummarizeResourcesRolesByWBS() throws BusinessObjectException
      Gets the indicator that determines whether expense spread data has to be generated and assignment spread data has to take max depth from Summarize to WBS level during summarization for non-fusion projects.\n When the option is false for non-fusion type projects; creates resource/role summary record at the project level only and doesn't create expense summary data.\n When the option is true, max depth for resource/role spread data will use value of 'Summarize to WBS level' and expense summary data will be created. 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 SummarizeResourcesRolesByWBS
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setSummarizeResourcesRolesByWBS

      public void setSummarizeResourcesRolesByWBS(boolean b) throws BusinessObjectException
      Sets the indicator that determines whether expense spread data has to be generated and assignment spread data has to take max depth from Summarize to WBS level during summarization for non-fusion projects.\n When the option is false for non-fusion type projects; creates resource/role summary record at the project level only and doesn't create expense summary data.\n When the option is true, max depth for resource/role spread data will use value of 'Summarize to WBS level' and expense summary data will be created. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getProjectScheduleType

      public ProjectScheduleType getProjectScheduleType() throws BusinessObjectException
      Gets the type of schedule the project is based on. It can contain either "Duration" or "Resource" or "Cost".
      Returns:
      the value in the field ProjectScheduleType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setProjectScheduleType

      public void setProjectScheduleType(ProjectScheduleType enm) throws BusinessObjectException
      Sets the type of schedule the project is based on. It can contain either "Duration" or "Resource" or "Cost".
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getPropertyType

      public ProjPropType getPropertyType() throws BusinessObjectException
      Gets the project property name associated with the scheduling of projects.
      Returns:
      the value in the field PropertyType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getIgnoreOtherProjectRelationships

      public boolean getIgnoreOtherProjectRelationships() throws BusinessObjectException
      Gets the option used by the scheduler for treating activity relationships between projects when scheduling. 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 IgnoreOtherProjectRelationships
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCalculateFloatBasedOnFinishDate

      public boolean getCalculateFloatBasedOnFinishDate() throws BusinessObjectException
      Gets the flag that indicates how each activity's float will be calculated with respect to other projects in the scheduling batch. This setting only has an effect when scheduling multiple projects at the same time. If true, each activity's float is calculated based on its project's ScheduledFinishDate. If false, then each activity's float is calculated based on the latest ScheduledFinishDate of all of the projects in the scheduling batch. 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 CalculateFloatBasedOnFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getComputeTotalFloatType

      public ScheduleFloatType getComputeTotalFloatType() throws BusinessObjectException
      Gets the method for calculating total float for all activities. Start Float is the difference between the early and late start dates (Start Float = Late Start - Early Start); Finish Float is the difference between the early and late finish dates (Finish Float = Late Finish - Early Finish); and Smallest of Start Float and Finish Float is the most critical float 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 ComputeTotalFloatType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getLevelFloatThresholdCount

      public int getLevelFloatThresholdCount() throws BusinessObjectException
      Throws:
      BusinessObjectException
    • getLevelOuterAssign

      public boolean getLevelOuterAssign() throws BusinessObjectException
      Throws:
      BusinessObjectException
    • getLevelOuterAssignPriority

      public int getLevelOuterAssignPriority() throws BusinessObjectException
      Throws:
      BusinessObjectException
    • getLevelOverAllocationPercent

      public double getLevelOverAllocationPercent() throws BusinessObjectException
      Throws:
      BusinessObjectException
    • getLevelWithinFloat

      public boolean getLevelWithinFloat() throws BusinessObjectException
      Throws:
      BusinessObjectException
    • getLevelDateFlag

      public boolean getLevelDateFlag() throws BusinessObjectException
      Throws:
      BusinessObjectException
    • getLevelAllResources

      public boolean getLevelAllResources() throws BusinessObjectException
      Throws:
      BusinessObjectException
    • getLevelResourceList

      public String getLevelResourceList() throws BusinessObjectException
      Throws:
      BusinessObjectException
    • getLevelPriorityList

      public String getLevelPriorityList() throws BusinessObjectException
      Throws:
      BusinessObjectException
    • getCriticalActivityFloatThreshold

      public Duration getCriticalActivityFloatThreshold() throws BusinessObjectException
      Gets the maximum float time for activities before they are marked critical. 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 CriticalActivityFloatThreshold
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getMakeOpenEndedActivitiesCritical

      public boolean getMakeOpenEndedActivitiesCritical() throws BusinessObjectException
      Gets the option used by the scheduler for automatically leveling resources when scheduling projects. 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 MakeOpenEndedActivitiesCritical
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getMaximumMultipleFloatPaths

      public int getMaximumMultipleFloatPaths() throws BusinessObjectException
      Gets the number of critical float paths to calculate. For example, if you set the field to five, the module calculates the five most critical float paths ending with the activity you selected. The module ranks each float path from most critical to least critical, and stores the value for each activity in the Float Path field. For example, if you calculate five float paths, the module will store a value of one in the Float Path field for each activity in the most critical float path; the module will store a value of five for each activity in the least critical float path. Note: To view the critical float paths after you schedule the project, group activities in the Activity Table by Float Path and sort by Float Path Order. A Float Path value of one indicates that those activities are part of the most critical float path. The Float Path Order value indicates the order in which the activities were processed. 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 MaximumMultipleFloatPaths
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getMultipleFloatPathsEnabled

      public boolean getMultipleFloatPathsEnabled() throws BusinessObjectException
      Gets the Boolean value that indicates whether multiple critical float paths (sequences of activities) should be calculated in the project schedule. 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 MultipleFloatPathsEnabled
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getMultipleFloatPathsEndingActivityObjectId

      public ObjectId getMultipleFloatPathsEndingActivityObjectId() throws BusinessObjectException
      Gets the activity in the WBS that you want to represent the end of the float paths. Typically, this will be a milestone activity or some other significant activity that has a start date or end date that cannot change. Note: if a value is not assigned, the module will choose an activity based on MultipleFloatPathsUseTotalFloat. If you are calculating multiple paths using Free Float, the module will choose the open-ended activity with the most critical Free Float. If you are calculating multiple paths using Total Float, the module will calculate the Total Float for all activity relationships, then choose the activity with the most critical Relationship Total Float. 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 MultipleFloatPathsEndingActivityObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getMultipleFloatPathsUseTotalFloat

      public boolean getMultipleFloatPathsUseTotalFloat() throws BusinessObjectException
      Gets the Boolean value that decides whether or not to use total float in multiple float path calculations.

      If True, then based on the activity you want the paths to end on, the module determines which predecessor activity has the most critical Relationship Total Float on the backward pass. The module repeats this process until an activity is reached that has no relationship. The module begins the forward pass from this activity and determines which successor activity has the most critical Relationship Successor Total Float. The module repeats this process until an activity is reached that has no relationship. These activities represent the most critical float path. The process begins again until the remaining sub-critical paths are calculated.

      If False, then critical float paths are defined based on longest path. The most critical path will be identical to the critical path that is derived when you choose to define critical activities as Longest Path in the General tab. In a multicalendar project, the longest path is calculated by identifying the activities that have an early finish equal to the latest calculated early finish for the project and tracing all driving relationships for those activities back to the project start date. After the most critical path is identified, the module will calculate the remaining sub-critical paths.

      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 MultipleFloatPathsUseTotalFloat
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getOutOfSequenceScheduleType

      public OutOfSequenceScheduleType getOutOfSequenceScheduleType() throws BusinessObjectException
      Gets the type of logic used to schedule the progressed activities: 'Retained Logic', 'Progress Override', or 'Actual Dates'. 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 OutOfSequenceScheduleType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getRelationshipLagCalendar

      public ScheduleRelationshipLagCalendar getRelationshipLagCalendar() throws BusinessObjectException
      Gets the calendar used to calculate the lag between predecessors and successors for all activities. Valid values are 'Predecessor Activity Calendar', 'Successor Activity Calendar', '24 Hour Calendar', and 'Project Default Calendar'. If you do not select a calendar, the successor activity calendar is used. 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 RelationshipLagCalendar
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getStartToStartLagCalculationType

      public boolean getStartToStartLagCalculationType() throws BusinessObjectException
      Gets the method used to calculate lag when a start-to-start relationship exists and the predecessor starts out of sequence. Actual Start sets the successor's start according to the time elapsed from the predecessor's actual start (the successor's start date is the data date plus any remaining lag). Early Start sets the successor's start according to the amount of work that the predecessor activity accomplishes (the expired lag is calculated as the number of work periods between the actual start and the data date, and the successor's start date is the predecessor's internal early start plus any remaining lag). 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 StartToStartLagCalculationType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getUseExpectedFinishDates

      public boolean getUseExpectedFinishDates() throws BusinessObjectException
      Gets the option used for setting activity finish dates as the expected finish dates when scheduling projects. 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 UseExpectedFinishDates
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getLimitMultipleFloatPaths

      public boolean getLimitMultipleFloatPaths() throws BusinessObjectException
      Gets the option used for enabling/disabling limit multiple float paths when scheduling projects. 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 LimitMultipleFloatPaths
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCriticalFloatThreshold

      public double getCriticalFloatThreshold() throws BusinessObjectException
      Gets the option used for setting the critical float threshold value when scheduling projects. 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 CriticalFloatThreshold
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSyncWbsHierarchyFlag

      public boolean getSyncWbsHierarchyFlag() throws BusinessObjectException
      Gets the option used for enabling/disabling WBS Hierachy sync. 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 SyncWbsHierarchyFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getScheduleWBSHierarchyType

      public ScheduleWBSHierarchyType getScheduleWBSHierarchyType() throws BusinessObjectException
      Gets the option used for specifying WBS Hierachy sync type. 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 ScheduleWBSHierarchyType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getWBSHierarchyLevels

      public int getWBSHierarchyLevels() throws BusinessObjectException
      Gets the option used for specifying WBS Hierachy sync level. 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 WBSHierarchyLevels
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getUnifierEnabledFlag

      public boolean getUnifierEnabledFlag() throws BusinessObjectException
      Gets flag to enable Unifier schedule sheet integration. 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 UnifierEnabledFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setUnifierEnabledFlag

      public void setUnifierEnabledFlag(boolean b) throws BusinessObjectException
      Sets flag to enable Unifier schedule sheet integration. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getUnifierProjectName

      public String getUnifierProjectName() throws BusinessObjectException
      Gets field to specify Unifier project number. 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 UnifierProjectName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setUnifierProjectName

      public void setUnifierProjectName(String s) throws BusinessObjectException
      Sets field to specify Unifier project number. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getUnifierProjectNumber

      public String getUnifierProjectNumber() throws BusinessObjectException
      Gets field to specify Unifier project number. 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 UnifierProjectNumber
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setUnifierProjectNumber

      public void setUnifierProjectNumber(String s) throws BusinessObjectException
      Sets field to specify Unifier project number. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getUnifierScheduleSheetName

      public String getUnifierScheduleSheetName() throws BusinessObjectException
      Gets field to specify Unifier schedule sheet name. 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 UnifierScheduleSheetName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setUnifierScheduleSheetName

      public void setUnifierScheduleSheetName(String s) throws BusinessObjectException
      Sets field to specify Unifier schedule sheet name. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getUnifierDataMappingName

      public String getUnifierDataMappingName() throws BusinessObjectException
      Gets field to specify Unifier data mapping name. 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 UnifierDataMappingName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setUnifierDataMappingName

      public void setUnifierDataMappingName(String s) throws BusinessObjectException
      Sets field to specify Unifier data mapping name. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getUnifierDeleteActivitiesFlag

      public boolean getUnifierDeleteActivitiesFlag() throws BusinessObjectException
      Gets delete activities no longer in the P6 Schedule from Primavera Unifier. 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 UnifierDeleteActivitiesFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setUnifierDeleteActivitiesFlag

      public void setUnifierDeleteActivitiesFlag(boolean b) throws BusinessObjectException
      Sets delete activities no longer in the P6 Schedule from Primavera Unifier. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getUnifierCBSTasksOnlyFlag

      public boolean getUnifierCBSTasksOnlyFlag() throws BusinessObjectException
      Gets only send activities with CBS codes 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 UnifierCBSTasksOnlyFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setUnifierCBSTasksOnlyFlag

      public void setUnifierCBSTasksOnlyFlag(boolean b) throws BusinessObjectException
      Sets only send activities with CBS codes assigned. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getEnablePrimeSycFlag

      public boolean getEnablePrimeSycFlag() throws BusinessObjectException
      Gets flag to enable real time P6-Prime sync.
      Returns:
      the value in the field EnablePrimeSycFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setEnablePrimeSycFlag

      public void setEnablePrimeSycFlag(boolean b) throws BusinessObjectException
      Sets flag to enable real time P6-Prime sync.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getEtlInterval

      public EtlInterval getEtlInterval() throws BusinessObjectException
      Gets the time interval for ETL for use in P6 Analytics, could be 'None', 'Scheduled', 'Immediate'.
      Returns:
      the value in the field EtlInterval
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setEtlInterval

      public void setEtlInterval(EtlInterval enm) throws BusinessObjectException
      Sets the time interval for ETL for use in P6 Analytics, could be 'None', 'Scheduled', 'Immediate'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getPerformancePercentCompleteByLaborUnits

      public Percent getPerformancePercentCompleteByLaborUnits() throws BusinessObjectException
      Gets performancePercentCompleteByLaborUnits = ('Earned Value Labor Units' / 'Budget at Completion Labor Units') * 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 PerformancePercentCompleteByLaborUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getPreResponsePessimisticStart

      public BeginDate getPreResponsePessimisticStart() throws BusinessObjectException
      Gets pre response Project Pessimistic start.
      Returns:
      the value in the field PreResponsePessimisticStart
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setPreResponsePessimisticStart

      public void setPreResponsePessimisticStart(BeginDate d) throws BusinessObjectException
      Sets pre response Project Pessimistic start.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getPreResponsePessimisticFinish

      public EndDate getPreResponsePessimisticFinish() throws BusinessObjectException
      Gets pre response Project Pessimistic finish.
      Returns:
      the value in the field PreResponsePessimisticFinish
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setPreResponsePessimisticFinish

      public void setPreResponsePessimisticFinish(EndDate d) throws BusinessObjectException
      Sets pre response Project Pessimistic finish.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getPostResponsePessimisticStart

      public BeginDate getPostResponsePessimisticStart() throws BusinessObjectException
      Gets post response Project Pessimistic start.
      Returns:
      the value in the field PostResponsePessimisticStart
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setPostResponsePessimisticStart

      public void setPostResponsePessimisticStart(BeginDate d) throws BusinessObjectException
      Sets post response Project Pessimistic start.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getPostResponsePessimisticFinish

      public EndDate getPostResponsePessimisticFinish() throws BusinessObjectException
      Gets post response Project Pessimistic finish.
      Returns:
      the value in the field PostResponsePessimisticFinish
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setPostResponsePessimisticFinish

      public void setPostResponsePessimisticFinish(EndDate d) throws BusinessObjectException
      Sets post response Project Pessimistic finish.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getFinancialPeriodTemplateId

      public ObjectId getFinancialPeriodTemplateId() throws BusinessObjectException
      Gets the unique ID generated by the system.
      Returns:
      the value in the field FinancialPeriodTemplateId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setFinancialPeriodTemplateId

      public void setFinancialPeriodTemplateId(ObjectId o) throws BusinessObjectException
      Sets the unique ID generated by the system.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getResourceName

      public String getResourceName() throws BusinessObjectException
      Gets the name of the resource assigned to the project.
      Returns:
      the value in the field ResourceName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getPrimaryBaselineObjectId

      public ObjectId getPrimaryBaselineObjectId() throws BusinessObjectException
      Gets the assigned Primary Baeline Id. 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 PrimaryBaselineObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setPrimaryBaselineObjectId

      public void setPrimaryBaselineObjectId(ObjectId o) throws BusinessObjectException
      Sets the assigned Primary Baeline Id. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSecondaryBaselineObjectId

      public ObjectId getSecondaryBaselineObjectId() throws BusinessObjectException
      Gets the assigned Secondary Baeline Id. 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 SecondaryBaselineObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setSecondaryBaselineObjectId

      public void setSecondaryBaselineObjectId(ObjectId o) throws BusinessObjectException
      Sets the assigned Secondary Baeline Id. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTertiaryBaselineObjectId

      public ObjectId getTertiaryBaselineObjectId() throws BusinessObjectException
      Gets the assigned Tertiary Baeline Id. 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 TertiaryBaselineObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTertiaryBaselineObjectId

      public void setTertiaryBaselineObjectId(ObjectId o) throws BusinessObjectException
      Sets the assigned Tertiary Baeline Id. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • loadCalculatedUDFValues

      public BOIterator<UDFValue> loadCalculatedUDFValues(UDFType[] udfTypes) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated UDFValue objects
      Parameters:
      udfTypes - the udf types to load UDFValue objects for
      Throws:
      ServerException
      NetworkException
      BusinessObjectException
    • 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 non-code 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
    • getResourceSpreadFields

      public static String[] getResourceSpreadFields()
      Gets all spread fields that can be specified in the spreadFields parameter of loadWithResourceSpread methods for this business object.
      Returns:
      String[] an array of all spread fields
    • getResourceAssignmentCBSSpreadFields

      public static String[] getResourceAssignmentCBSSpreadFields()
      Gets all spread fields that can be specified in the spreadFields parameter of loadWithResourceCBSSpread methods for this business object.
      Returns:
      String[] an array of all spread fields
    • getExpenseCategoryCBSSpreadFields

      public static String[] getExpenseCategoryCBSSpreadFields()
      Gets all spread fields that can be specified in the spreadFields parameter of loadWithExpenseCategoryCBSSpread methods for this business object.
      Returns:
      String[] an array of all spread fields
    • getRoleSpreadFields

      public static String[] getRoleSpreadFields()
      Gets all spread fields that can be specified in the spreadFields parameter of loadWithRoleSpreadSpread 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 Project object in the database.
      Returns:
      ObjectId the 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
    • create

      public static ObjectId[] create(Session session, Project[] projects) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple Project objects in the database.
      Parameters:
      session - the Session object
      projects - array of Project objects to create
      Returns:
      ObjectId[] the array of unique 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
    • load

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

      public static BOIterator<Project> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple Project objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the Project 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 Project loadWithSummarizedSpread(Session session, String[] nonSpreadFields, ObjectId objId, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Loads a Project object with summarized spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      objId - unique ID of the Project 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:
      Project the Project object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • loadWithSummarizedSpread

      public static BOIterator<Project> loadWithSummarizedSpread(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple Project objects with summarized spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      objIds - object ids of the Project 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
    • loadWithProjectResourceSpread

      public static Project loadWithProjectResourceSpread(Session session, String[] nonSpreadFields, ObjectId objId, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative, ObjectId[] resourceObjectIds) throws ServerException, NetworkException, BusinessObjectException
      Loads a Project object with summarized spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      objId - unique ID of the Project 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
      resourceObjectIds - object ids of the Resource objects
      Returns:
      Project the Project object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • loadWithProjectResourceSpread

      public static BOIterator<Project> loadWithProjectResourceSpread(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative, ObjectId[] resourceObjectIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple Project objects with summarized spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      objIds - object ids of the Project 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
      resourceObjectIds - object ids of the Resource 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
    • loadWithResourceAssignmentCBSSpread

      public static Project loadWithResourceAssignmentCBSSpread(Session session, String[] nonSpreadFields, ObjectId objId, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative, ObjectId[] resourcecbsObjectIds) throws ServerException, NetworkException, BusinessObjectException
      Loads a Project object with summarized spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      objId - unique ID of the Project 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
      resourcecbsObjectIds - object ids of the ResourceCBS objects
      Returns:
      Project the Project object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • loadWithResourceAssignmentCBSSpread

      public static BOIterator<Project> loadWithResourceAssignmentCBSSpread(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative, ObjectId[] resourcecbsObjectIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple Project objects with summarized spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      objIds - object ids of the Project 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
      resourcecbsObjectIds - object ids of the ResourceCBS 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
    • loadWithExpenseCategoryCBSSpread

      public static Project loadWithExpenseCategoryCBSSpread(Session session, String[] nonSpreadFields, ObjectId objId, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative, ObjectId[] expensecategorycbsObjectIds) throws ServerException, NetworkException, BusinessObjectException
      Loads a Project object with summarized spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      objId - unique ID of the Project 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
      expensecategorycbsObjectIds - object ids of the ExpenseCategoryCBS objects
      Returns:
      Project the Project object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • loadWithExpenseCategoryCBSSpread

      public static BOIterator<Project> loadWithExpenseCategoryCBSSpread(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative, ObjectId[] expensecategorycbsObjectIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple Project objects with summarized spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      objIds - object ids of the Project 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
      expensecategorycbsObjectIds - object ids of the ExpenseCategoryCBS 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
    • loadWithProjectRoleSpread

      public static Project loadWithProjectRoleSpread(Session session, String[] nonSpreadFields, ObjectId objId, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative, ObjectId[] roleObjectIds) throws ServerException, NetworkException, BusinessObjectException
      Loads a Project object with summarized spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      objId - unique ID of the Project 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
      roleObjectIds - object ids of the Role objects
      Returns:
      Project the Project object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • loadWithProjectRoleSpread

      public static BOIterator<Project> loadWithProjectRoleSpread(Session session, String[] nonSpreadFields, ObjectId[] objIds, String[] spreadFields, SpreadPeriodType periodType, Date startDate, Date endDate, boolean bIncludeCumulative, ObjectId[] roleObjectIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple Project objects with summarized spreads from the database.
      Parameters:
      nonSpreadFields - fields to load
      objIds - object ids of the Project 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
      roleObjectIds - object ids of the Role 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
    • loadWithSpreads

      public static BOIterator<Project> loadWithSpreads(Session session, String[] nonSpreadFields, String sWhereClause, String sOrderBy, SpreadOptions... spreadOptions) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple Project objects with spreads from the database.
      Parameters:
      session - the Session object
      nonSpreadFields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      spreadOptions - spread options
      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
    • loadWithSpreads

      public static BOIterator<Project> loadWithSpreads(Session session, String[] nonSpreadFields, ObjectId[] objIds, SpreadOptions... spreadOptions) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple Project objects with spreads from the database.
      Parameters:
      session - the Session object
      nonSpreadFields - fields to load
      objIds - object ids of the Project objects
      spreadOptions - spread options
      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
    • loadWithSpreads

      public static Project loadWithSpreads(Session session, String[] nonSpreadFields, ObjectId objId, SpreadOptions... spreadOptions) throws ServerException, NetworkException, BusinessObjectException
      Loads a Project object with spreads from the database.
      Parameters:
      session - the Session object
      nonSpreadFields - fields to load
      objId - unique ID of the Project object
      spreadOptions - spread options
      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 Project 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, Project[] projects) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple Project objects in the database.
      Parameters:
      session - the Session object
      projects - array of Project 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 Project 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, Project[] projects) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple Project objects from the database.
      Parameters:
      session - the Session object
      projects - array of Project 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