Primavera Integration API 7.0

com.primavera.integration.client.bo.object
Class ActivityCodeAssignment

java.lang.Object
  extended by com.primavera.integration.client.BOBase
      extended by com.primavera.integration.client.bo.BusinessObject
          extended by 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.

See Also:   Quick reference of ActivityCodeAssignment fields


Constructor Summary
ActivityCodeAssignment(Session session)
          Class constructor specifying the Session.
ActivityCodeAssignment(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
ActivityCodeAssignment(Session session, ObjectId activityObjectId, ObjectId activityCodeTypeObjectId)
          Class constructor specifying the Session and the individual components of the multi-part key: ActivityObjectId and ActivityCodeTypeObjectId.
ActivityCodeAssignment(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)
          Class constructor called internally after objects are retrieved from the server.
 
Method Summary
 ObjectId create()
          Creates this ActivityCodeAssignment object in the database.
static ObjectId[] create(Session session, ActivityCodeAssignment[] activitycodeassignments)
          Creates multiple ActivityCodeAssignment objects in the database.
static ObjectId createObjectId(ObjectId activityObjectId, ObjectId activityCodeTypeObjectId)
          Creates a multi-part ObjectId from two individual ObjectIds.
 void delete()
          Deletes this ActivityCodeAssignment object from the database.
static void delete(Session session, ActivityCodeAssignment[] activitycodeassignments)
          Deletes multiple ActivityCodeAssignment objects from the database.
 java.lang.String getActivityCodeDescription()
          Gets the description of the associated activity code.
 ObjectId getActivityCodeObjectId()
          Gets the unique ID of the associated activity code.
 java.lang.String getActivityCodeTypeName()
          Gets the name of the parent activity code type.
 ObjectId getActivityCodeTypeObjectId()
          Gets the unique ID of the parent activity code type.
 ActivityCodeTypeScope getActivityCodeTypeScope()
          Gets the scope of the associated activity code type: Global, EPS, or Project.
 java.lang.String getActivityCodeValue()
          Gets the value of the associated activity code.
 java.lang.String getActivityId()
          Gets the short ID that uniquely identifies the activity to which the activity code is assigned.
 java.lang.String getActivityName()
          Gets the name of the activity to which the activity code is assigned.
 ObjectId getActivityObjectId()
          Gets the unique ID of the activity to which the activity code is assigned.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 java.util.Date getCreateDate()
          Gets the date this code assignment was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this code assignment.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
static java.lang.String[] getFilterableFields()
          Gets all fields that can be filtered.
static java.lang.String[] getInternalAllFields()
          An internal method that should not be called directly by client code.
static java.util.Set<java.lang.String> getInternalAllFieldsSet()
          An internal method that should not be called directly by client code.
static java.lang.String[] getInternalDefaultLoadFields()
          An internal method that should not be called directly by client code.
 boolean getIsBaseline()
          Gets the boolean value indicating if this business object is related to a Project or Baseline.
 java.util.Date getLastUpdateDate()
          Gets the date this code assignment was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this code assignment.
static java.lang.String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 ObjectId getObjectId()
          Gets the ObjectId for this object.
 java.lang.String getProjectId()
          Gets the short code of the associated project.
 ObjectId getProjectObjectId()
          Gets the unique ID of the associated project.
static java.lang.String[] getRequiredCreateFields()
          Gets all fields that must be set before calling create() on this business object.
 ObjectId getWBSObjectId()
          Gets the unique ID of the WBS for the associated activity.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static ActivityCodeAssignment load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single ActivityCodeAssignment object from the database.
static BOIterator<ActivityCodeAssignment> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple ActivityCodeAssignment objects from the database.
 Activity loadActivity(java.lang.String[] fields)
          Loads an associated Activity object from the database.
 ActivityCode loadActivityCode(java.lang.String[] fields)
          Loads an associated ActivityCode object from the database.
 ActivityCodeType loadActivityCodeType(java.lang.String[] fields)
          Loads an associated ActivityCodeType object from the database.
 Project loadProject(java.lang.String[] fields)
          Loads an associated Project object from the database.
 void setActivityCodeObjectId(ObjectId o)
          Sets the unique ID of the associated activity code.
 void setActivityObjectId(ObjectId o)
          Sets the unique ID of the activity to which the activity code is assigned.
 java.lang.String toString()
          Returns a string representation of the object.
 void update()
          Updates this ActivityCodeAssignment object in the database.
static void update(Session session, ActivityCodeAssignment[] activitycodeassignments)
          Updates multiple ActivityCodeAssignment objects in the database.
 
Methods inherited from class com.primavera.integration.client.bo.BusinessObject
equals, hashCode, isNull, setNull, setObjectId
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

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 Detail

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.
java.lang.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,
                                          java.lang.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,
                                                      java.lang.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.

Overrides:
update in class BOBase
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.

Overrides:
delete in class BOBase
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

loadActivityCodeType

public ActivityCodeType loadActivityCodeType(java.lang.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(java.lang.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(java.lang.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(java.lang.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 java.lang.String getActivityId()
                               throws BusinessObjectException
Gets the short ID that uniquely identifies 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.

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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.util.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 java.util.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 java.lang.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 java.lang.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

getRequiredCreateFields

public static java.lang.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 java.lang.String[] getFilterableFields()
Gets all fields that can be filtered.

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

public static java.lang.String[] getInternalDefaultLoadFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getAllFields

public static java.lang.String[] getAllFields()
Gets all fields for this business object.

Returns:
String[] an array of all fields

getInternalAllFields

public static java.lang.String[] getInternalAllFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getInternalAllFieldsSet

public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getWritableFields

public static java.lang.String[] getWritableFields()
Gets all writable fields for this business object.

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

public static java.lang.String[] getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified.

Returns:
String[] an array of field names

getMinimumXMLExportFields

public static java.lang.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 java.lang.String toString()
Returns a string representation of the object. The output is in XML.

Overrides:
toString in class java.lang.Object
Returns:
String a string representation of the object.

Primavera Integration API 7.0

Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.