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

Class ResourceAssignmentCreate

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.ResourceAssignmentCreate
public class ResourceAssignmentCreate extends BusinessObject
The ResourceAssignmentCreate object stores resource assignment requested by Team Members. This assignment will be auto approved with status 'Added'.

See Also:   Quick reference of ResourceAssignmentCreate fields

  • Constructor Details

    • ResourceAssignmentCreate

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

    • ResourceAssignmentCreate

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

    • ResourceAssignmentCreate

      public ResourceAssignmentCreate(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 Changeset. 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 Changeset. 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

    • getResourceAssignmentObjectId

      public ObjectId getResourceAssignmentObjectId() throws BusinessObjectException
      Gets the unique ID of the ResourceAssignment associated to the ResourceAssignmentCreate.
      Returns:
      the value in the field ResourceAssignmentObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getResourceAssignmentCreateObjectId

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

    • setResourceAssignmentCreateObjectId

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

    • getProjectObjectId

      public ObjectId getProjectObjectId() throws BusinessObjectException
      Gets the unique ID of the Project associated to the AssignmentUpdate.
      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 resource assignment : 'Added'.
      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 resource assignment : 'Added'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRemainingUnits

      public Unit getRemainingUnits() throws BusinessObjectException
      Gets the remaining units of work to be performed by this resource on this activity.
      Returns:
      the value in the field RemainingUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRemainingUnits

      public void setRemainingUnits(Unit u) throws BusinessObjectException
      Sets the remaining units of work to be performed by this resource on this activity.
      Parameters:
      u - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualUnits

      public Unit getActualUnits() throws BusinessObjectException
      Gets the actual units worked by the resource on this activity.
      Returns:
      the value in the field ActualUnits
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualUnits

      public void setActualUnits(Unit u) throws BusinessObjectException
      Sets the actual units worked by the resource on this activity.
      Parameters:
      u - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getAssignmentIsRead

      public String getAssignmentIsRead() throws BusinessObjectException
      Gets to identify if the newly created assignment from TM is viewed by the manager in CSU or not.
      Returns:
      the value in the field AssignmentIsRead
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setAssignmentIsRead

      public void setAssignmentIsRead(String s) throws BusinessObjectException
      Sets to identify if the newly created assignment from TM is viewed by the manager in CSU or not.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualStartDate

      public BeginDate getActualStartDate() throws BusinessObjectException
      Gets the date the resource actually started working on the activity.
      Returns:
      the value in the field ActualStartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualStartDate

      public void setActualStartDate(BeginDate d) throws BusinessObjectException
      Sets the date the resource actually started working on the activity.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualFinishDate

      public EndDate getActualFinishDate() throws BusinessObjectException
      Gets the date the resource actually finished working on the activity.
      Returns:
      the value in the field ActualFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualFinishDate

      public void setActualFinishDate(EndDate d) throws BusinessObjectException
      Sets the date the resource actually finished working on the activity.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRemainingDuration

      public Duration getRemainingDuration() throws BusinessObjectException
      Gets the remaining duration of the resource assignment.
      Returns:
      the value in the field RemainingDuration
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRemainingDuration

      public void setRemainingDuration(Duration d) throws BusinessObjectException
      Sets the remaining duration of the resource assignment.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRemainingFinishDate

      public EndDate getRemainingFinishDate() throws BusinessObjectException
      Gets the remaining finish date for the resource working on the activity.
      Returns:
      the value in the field RemainingFinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRemainingFinishDate

      public void setRemainingFinishDate(EndDate d) throws BusinessObjectException
      Sets the remaining finish date for the resource working on the activity.
      Parameters:
      d - 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 assignment is assigned. 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 assignment is assigned. 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

    • getRequestUserObjectId

      public ObjectId getRequestUserObjectId() throws BusinessObjectException
      Gets the unique ID of the user modifying the task, assignment or step.
      Returns:
      the value in the field RequestUserObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getResourceObjectId

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

    • setResourceObjectId

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

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