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

Class CBSDurationSummary

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.CBSDurationSummary
public class CBSDurationSummary extends BusinessObject
CBS is cost breakdown structure.

See Also:   Quick reference of CBSDurationSummary fields

  • Constructor Details

    • CBSDurationSummary

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

    • CBSDurationSummary

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

    • CBSDurationSummary

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

    • loadProject

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

    • loadCBS

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

    • loadBaselineProject

      public BaselineProject loadBaselineProject(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

    • getProjectObjectId

      public ObjectId getProjectObjectId() throws BusinessObjectException
      Gets the unique id of the associated project. This field is automatically loaded by default whenever this type of business object is loaded from the database. 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 ProjectObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCBSObjectId

      public ObjectId getCBSObjectId() 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. 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 CBSObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getProjectId

      public String getProjectId() throws BusinessObjectException
      Gets the short name of the project.
      Returns:
      the value in the field ProjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getProjectName

      public String getProjectName() throws BusinessObjectException
      Gets the short name of the project.
      Returns:
      the value in the field ProjectName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getOriginalProjectObjectId

      public ObjectId getOriginalProjectObjectId() throws BusinessObjectException
      Gets the original object ID generated of the project.
      Returns:
      the value in the field OriginalProjectObjectId
      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

    • 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

    • 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

    • 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

    • 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

    • getSummaryPlannedDuration

      public Duration getSummaryPlannedDuration() throws BusinessObjectException
      Gets summarized Planned duration of 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

    • getSummaryRemainingDuration

      public Duration getSummaryRemainingDuration() throws BusinessObjectException
      Gets summarized Remaining duration of 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 SummaryRemainingDuration
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSummaryActualDuration

      public Duration getSummaryActualDuration() throws BusinessObjectException
      Gets summarized Actual duration of 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 SummaryActualDuration
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSummaryPercentComplete

      public Percent getSummaryPercentComplete() throws BusinessObjectException
      Gets summarized Percent complete of 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 SummaryPercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRequiredCreateFields

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

    • getFilterableFields

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

    • getInternalDefaultLoadFields

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

    • getAllFields

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

    • getInternalAllFields

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

    • getInternalAllFieldsSet

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

    • getWritableFields

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

    • getDefaultXMLExportFields

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

    • getMinimumXMLExportFields

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

    • toString

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

    • create

      public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
      Creates this CBSDurationSummary object in the database.
      Returns:
      ObjectId the unique ID of the newly created CBSDurationSummary 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, CBSDurationSummary[] cbsdurationsummarys) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple CBSDurationSummary objects in the database.
      Parameters:
      session - the Session object
      cbsdurationsummarys - array of CBSDurationSummary objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created CBSDurationSummary 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 CBSDurationSummary load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single CBSDurationSummary object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the CBSDurationSummary object
      Returns:
      CBSDurationSummary the CBSDurationSummary 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<CBSDurationSummary> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple CBSDurationSummary objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the CBSDurationSummary objects
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • update

      public void update() throws ServerException, NetworkException, BusinessObjectException
      Updates this CBSDurationSummary 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, CBSDurationSummary[] cbsdurationsummarys) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple CBSDurationSummary objects in the database.
      Parameters:
      session - the Session object
      cbsdurationsummarys - array of CBSDurationSummary objects to update
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • delete

      public void delete() throws ServerException, NetworkException, BusinessObjectException
      Deletes this CBSDurationSummary 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, CBSDurationSummary[] cbsdurationsummarys) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple CBSDurationSummary objects from the database.
      Parameters:
      session - the Session object
      cbsdurationsummarys - array of CBSDurationSummary 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