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

Class ActivityStepCreate

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.ActivityStepCreate
public class ActivityStepCreate extends BusinessObject
The ActivityStepCreate object stores activity step create details requested by Team Member.

See Also:   Quick reference of ActivityStepCreate fields

  • Constructor Details

    • ActivityStepCreate

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

    • ActivityStepCreate

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

    • ActivityStepCreate

      public ActivityStepCreate(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. This field must contain a valid value in order to create this type of business object in the database.
      Returns:
      the value in the field ActivityObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActivityObjectId

      public void setActivityObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the 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. 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

    • 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.
      Returns:
      the value in the field ActivityStepObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getDate

      public Date getDate() throws BusinessObjectException
      Gets the date when this step was created.
      Returns:
      the value in the field Date
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActivityStepName

      public String getActivityStepName() throws BusinessObjectException
      Gets the step name for this Activity step.
      Returns:
      the value in the field ActivityStepName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActivityStepName

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

    • getStepPercentComplete

      public Percent getStepPercentComplete() throws BusinessObjectException
      Gets the step percent complete for this Activity step. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field StepPercentComplete
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setStepPercentComplete

      public void setStepPercentComplete(Percent p) throws BusinessObjectException
      Sets the step percent complete for this Activity step. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      p - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getStepWeight

      public double getStepWeight() throws BusinessObjectException
      Gets the weight that is assigned to the step.
      Returns:
      the value in the field StepWeight
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setStepWeight

      public void setStepWeight(double d) throws BusinessObjectException
      Sets the weight that is assigned to the step.
      Parameters:
      d - 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

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