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

Class ActivityStepUpdate

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.ActivityStepUpdate
public class ActivityStepUpdate extends BusinessObject
The ActivityStepUpdate object stores activity step status updates requested by Team Members. These updates can be approved and/or overridden by the Project Manager.

See Also:   Quick reference of ActivityStepUpdate fields

  • Constructor Details

    • ActivityStepUpdate

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

    • ActivityStepUpdate

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

    • ActivityStepUpdate

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

    • getChangeSetObjectId

      public ObjectId getChangeSetObjectId() throws BusinessObjectException
      Gets the unique ID of the associated change set. 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 ChangeSetObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setChangeSetObjectId

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

    • getActivityObjectId

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

    • getActivityStepObjectId

      public ObjectId getActivityStepObjectId() throws BusinessObjectException
      Gets the unique ID of the associated step. 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 ActivityStepObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActivityStepObjectId

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

    • getProjectObjectId

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

    • getDate

      public Date getDate() throws BusinessObjectException
      Gets the date updates were made.
      Returns:
      the value in the field Date
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getStatus

      public ApprovalStatus getStatus() throws BusinessObjectException
      Gets the status of the requested activity step changes: 'Pending', 'Approved' or 'Held'.
      Returns:
      the value in the field Status
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setStatus

      public void setStatus(ApprovalStatus enm) throws BusinessObjectException
      Sets the status of the requested activity step changes: 'Pending', 'Approved' or 'Held'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRequestUserObjectId

      public ObjectId getRequestUserObjectId() throws BusinessObjectException
      Gets the unique ID of the user requesting this change.
      Returns:
      the value in the field RequestUserObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getApprovalUserObjectId

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

    • getApprovalUserName

      public String getApprovalUserName() throws BusinessObjectException
      Gets the name of the user approving this change.
      Returns:
      the value in the field ApprovalUserName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getApprovalDate

      public Date getApprovalDate() throws BusinessObjectException
      Gets the date the changes were approved.
      Returns:
      the value in the field ApprovalDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLastApprovedDate

      public Date getLastApprovedDate() throws BusinessObjectException
      Gets the date when user approves the changes.
      Returns:
      the value in the field LastApprovedDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setLastApprovedDate

      public void setLastApprovedDate(Date d) throws BusinessObjectException
      Sets the date when user approves the changes.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPendingPercentComplete

      public Percent getPendingPercentComplete() throws BusinessObjectException
      Gets the new percent complete for the step pending approval if required.
      Returns:
      the value in the field PendingPercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPendingPercentComplete

      public void setPendingPercentComplete(Percent p) throws BusinessObjectException
      Sets the new percent complete for the step pending approval if required.
      Parameters:
      p - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getOverridePercentComplete

      public Percent getOverridePercentComplete() throws BusinessObjectException
      Gets the overridden new percent complete for the step.
      Returns:
      the value in the field OverridePercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setOverridePercentComplete

      public void setOverridePercentComplete(Percent p) throws BusinessObjectException
      Sets the overridden new percent complete for the step.
      Parameters:
      p - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPendingStepName

      public String getPendingStepName() throws BusinessObjectException
      Gets the new step name pending approval if required.
      Returns:
      the value in the field PendingStepName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPendingStepName

      public void setPendingStepName(String s) throws BusinessObjectException
      Sets the new step name pending approval if required.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getOverrideStepName

      public String getOverrideStepName() throws BusinessObjectException
      Gets the overridden new step name for the step.
      Returns:
      the value in the field OverrideStepName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setOverrideStepName

      public void setOverrideStepName(String s) throws BusinessObjectException
      Sets the overridden new step name for the step.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getHeldDate

      public Date getHeldDate() throws BusinessObjectException
      Gets the date the changes were marked held.
      Returns:
      the value in the field HeldDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setHeldDate

      public void setHeldDate(Date d) throws BusinessObjectException
      Sets the date the changes were marked held.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRejectedBy

      public String getRejectedBy() throws BusinessObjectException
      Gets the name of the reviewer who rejected the changes.
      Returns:
      the value in the field RejectedBy
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRejectedBy

      public void setRejectedBy(String s) throws BusinessObjectException
      Sets the name of the reviewer who rejected the changes.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getResubmittedBy

      public String getResubmittedBy() throws BusinessObjectException
      Gets the name of the user who Resubmitted the changes.
      Returns:
      the value in the field ResubmittedBy
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setResubmittedBy

      public void setResubmittedBy(String s) throws BusinessObjectException
      Sets the name of the user who Resubmitted the changes.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateUser

      public String getCreateUser() throws BusinessObjectException
      Gets the name of the user who Created the changes.
      Returns:
      the value in the field CreateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setCreateUser

      public void setCreateUser(String s) throws BusinessObjectException
      Sets the name of the user who Created the changes.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRejectedDate

      public Date getRejectedDate() throws BusinessObjectException
      Gets the date the new changes were marked rejected.
      Returns:
      the value in the field RejectedDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRejectedDate

      public void setRejectedDate(Date d) throws BusinessObjectException
      Sets the date the new changes were marked rejected.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getResubmittedDate

      public Date getResubmittedDate() throws BusinessObjectException
      Gets the date the new changes were marked Resubmitted.
      Returns:
      the value in the field ResubmittedDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setResubmittedDate

      public void setResubmittedDate(Date d) throws BusinessObjectException
      Sets the date the new changes were marked Resubmitted.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getAllData

      public String getAllData() throws BusinessObjectException
      Gets row Data in Blob.
      Returns:
      the value in the field AllData
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setAllData

      public void setAllData(String s) throws BusinessObjectException
      Sets row Data in Blob.
      Parameters:
      s - the value to set this field to
      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 ActivityStepUpdate object in the database.
      Returns:
      ObjectId the unique ID of the newly created ActivityStepUpdate 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, ActivityStepUpdate[] activitystepupdates) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple ActivityStepUpdate objects in the database.
      Parameters:
      session - the Session object
      activitystepupdates - array of ActivityStepUpdate objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created ActivityStepUpdate 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 ActivityStepUpdate load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single ActivityStepUpdate object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the ActivityStepUpdate object
      Returns:
      ActivityStepUpdate the ActivityStepUpdate 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<ActivityStepUpdate> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple ActivityStepUpdate objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the ActivityStepUpdate 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 ActivityStepUpdate 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, ActivityStepUpdate[] activitystepupdates) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple ActivityStepUpdate objects in the database.
      Parameters:
      session - the Session object
      activitystepupdates - array of ActivityStepUpdate 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 ActivityStepUpdate 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, ActivityStepUpdate[] activitystepupdates) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple ActivityStepUpdate objects from the database.
      Parameters:
      session - the Session object
      activitystepupdates - array of ActivityStepUpdate 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