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

Class ActivityCodeAssignment

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.ActivityCodeAssignment
public class ActivityCodeAssignment extends BusinessObject

An activity code assignment business object represents the assignment of an activity code to an activity. For each activity code type, an activity may have zero or one activity codes assigned.

Note that this business object has a multi-part object ID; its object ID is a combination of its activity object ID and its activity code object ID. The method createObjectId() can be used to create the multi-part object ID from the individual IDs.

See Also:   Quick reference of ActivityCodeAssignment fields

  • Constructor Details

    • ActivityCodeAssignment

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

    • ActivityCodeAssignment

      public ActivityCodeAssignment(Session session, ObjectId objId) throws BusinessObjectException
      Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() is intended to be called on this object. For this particular object, the ObjectId is multi-part, created from the ActivityObjectId and ActivityCodeTypeObjectId field values. If you do not have the multi-part ObjectId already, it would be simpler to instead use the constructor that has multiple key parameters.
      Parameters:
      session - the Session
      objId - the ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • ActivityCodeAssignment

      public ActivityCodeAssignment(Session session, ObjectId activityObjectId, ObjectId activityCodeTypeObjectId) throws BusinessObjectException
      Class constructor specifying the Session and the individual components of the multi-part key: ActivityObjectId and ActivityCodeTypeObjectId. This constructor is most commonly used when update() is intended to be called on this object.
      Parameters:
      session - the Session
      activityObjectId - the first ObjectId in the key
      activityCodeTypeObjectId - the second ObjectId in the key
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • ActivityCodeAssignment

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

    • loadActivityCodeType

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

    • loadActivityCode

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

    • loadActivity

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

    • 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

    • getActivityObjectId

      public ObjectId getActivityObjectId() throws BusinessObjectException
      Gets the unique ID of the activity to which the activity code 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 activity code 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

    • getActivityId

      public String getActivityId() throws BusinessObjectException
      Gets the short ID that uniquely identifies the activity to which the activity code is assigned.
      Returns:
      the value in the field ActivityId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getWBSObjectId

      public ObjectId getWBSObjectId() throws BusinessObjectException
      Gets the unique ID of the WBS for the associated activity.
      Returns:
      the value in the field WBSObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActivityName

      public String getActivityName() throws BusinessObjectException
      Gets the name of the activity to which the activity code is assigned.
      Returns:
      the value in the field ActivityName
      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

    • getProjectId

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

    • getActivityCodeTypeObjectId

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

    • getActivityCodeObjectId

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

    • setActivityCodeObjectId

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

    • getActivityCodeTypeName

      public String getActivityCodeTypeName() throws BusinessObjectException
      Gets the name of the parent activity code type.
      Returns:
      the value in the field ActivityCodeTypeName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActivityCodeDescription

      public String getActivityCodeDescription() throws BusinessObjectException
      Gets the description of the associated activity code.
      Returns:
      the value in the field ActivityCodeDescription
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActivityCodeValue

      public String getActivityCodeValue() throws BusinessObjectException
      Gets the value of the associated activity code.
      Returns:
      the value in the field ActivityCodeValue
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActivityCodeTypeScope

      public ActivityCodeTypeScope getActivityCodeTypeScope() throws BusinessObjectException
      Gets the scope of the associated activity code type: Global, EPS, or Project. An activity code with Global scope can be assigned to any activity. An activity code with EPS scope can be assigned only to an activity within a project under that particular EPS. Similarly, an activity code with Project scope can be assigned only to an activity within that particular project.
      Returns:
      the value in the field ActivityCodeTypeScope
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateDate

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

    • getIsBaseline

      public boolean getIsBaseline() throws BusinessObjectException
      Gets the boolean value indicating if this business object is related to a Project or Baseline.
      Returns:
      the value in the field IsBaseline
      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 business object is related to a template Project.
      Returns:
      the value in the field IsTemplate
      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.

    • createObjectId

      public static ObjectId createObjectId(ObjectId activityObjectId, ObjectId activityCodeTypeObjectId) throws InvalidValueException
      Creates a multi-part ObjectId from two individual ObjectIds.
      Parameters:
      activityObjectId - the ObjectId of the associated activity object.
      activityCodeTypeObjectId - the ObjectId of the associated activityCodeType object.
      Returns:
      ObjectId the multi-part ObjectId
      Throws:
      InvalidValueException - if one of the input parameters was invalid.
      IllegalArgumentException - if one of the input parameters was null.

    • getObjectId

      public ObjectId getObjectId() throws BusinessObjectException
      Gets the ObjectId for this object. The ObjectId field serves as the primary key for the associated table in the database. For this object, the ObjectId is multi-part, consisting internally of the ActivityObjectId and ActivityCodeTypeObjectId fields.
      Overrides:
      getObjectId in class BusinessObject
      Returns:
      ObjectId the multi-part ObjectId of this object
      Throws:
      BusinessObjectException - if the ObjectId fields were not loaded.

    • create

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