Primavera Integration API 7.0

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

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.base.ActivityCodeBase
              extended by com.primavera.integration.client.bo.object.ActivityCode

public class ActivityCode
extends com.primavera.integration.client.bo.base.ActivityCodeBase

Activity codes are user-defined codes to classify and categorize activities according to the organization's and project's needs. They can be defined by project as well as globally across all projects. Activity codes are hierarchical objects.

For example, if your organization has more than one location, you can create a Location code type with values such as New York, Los Angeles, and Chicago. You can then associate activities with a specific location, such as New York.

You can define three types of activity codes, global activity codes, EPS activity codes, and project activity codes. You can assign global activity codes and values to activities in all projects. You can assign EPS activity codes and values to activities only in projects in the EPS for which the codes were created. You can assign project activity codes and values to activities only in the project for which the codes were created. Each activity code can have an unlimited number of values.

See Also:   Quick reference of ActivityCode fields


Constructor Summary
ActivityCode(Session session)
          Class constructor specifying the Session.
ActivityCode(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
ActivityCode(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 ActivityCode object in the database.
static ObjectId[] create(Session session, ActivityCode[] activitycodes)
          Creates multiple ActivityCode objects in the database.
 ObjectId createActivityCodeChild(ActivityCode activitycodechild)
          Creates an associated ActivityCode object in the database.
 ObjectId[] createActivityCodeChildren(ActivityCode[] activitycodechildren)
          Creates multiple associated ActivityCode objects in the database.
 void delete()
          Deletes this ActivityCode object from the database.
static void delete(Session session, ActivityCode[] activitycodes)
          Deletes multiple ActivityCode objects from the database.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 java.lang.String getCodeTypeName()
          Gets the name of the parent code type for this code.
 ObjectId getCodeTypeObjectId()
          Gets the unique ID of the parent activity code type.
 ActivityCodeTypeScope getCodeTypeScope()
          Gets the scope of the parent activity code type: Global, EPS, or Project.
 java.lang.String getCodeValue()
          Gets the value of the activity code.
 java.util.Date getCreateDate()
          Gets the date this activity code was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this activity code.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
 java.lang.String getDescription()
          Gets the description of the activity code.
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.
 java.util.Date getLastUpdateDate()
          Gets the date this activity code was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this activity code.
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 unique ID generated by the system.
 ObjectId getParentObjectId()
          Gets the unique ID of the parent activity code of this activity code in the hierarchy.
 ObjectId getProjectObjectId()
          Gets the unique project ID of the parent code type for this code if code type scope is 'Project' or 'EPS', null for code types with scope 'Global'.
static java.lang.String[] getRequiredCreateFields()
          Gets all fields that must be set before calling create() on this business object.
 int getSequenceNumber()
          Gets the sequence number for sorting.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static ActivityCode load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single ActivityCode object from the database.
static BOIterator<ActivityCode> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple ActivityCode objects from the database.
 BOIterator<Activity> loadActivities(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Load the Activity objects to which this activity code is assigned.
 BOIterator<ActivityCodeAssignment> loadActivityCodeAssignments(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityCodeAssignment objects from the database.
 BOIterator<ActivityCode> loadActivityCodeChildren(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityCode objects from the database.
 ActivityCodeType loadActivityCodeType(java.lang.String[] fields)
          Loads an associated ActivityCodeType object from the database.
 ActivityCode loadParentActivityCode(java.lang.String[] fields)
          Loads an associated ActivityCode object from the database.
 void setCodeTypeObjectId(ObjectId o)
          Sets the unique ID of the parent activity code type.
 void setCodeValue(java.lang.String s)
          Sets the value of the activity code.
 void setDescription(java.lang.String s)
          Sets the description of the activity code.
 void setObjectId(ObjectId o)
          Sets the unique ID generated by the system.
 void setParentObjectId(ObjectId o)
          Sets the unique ID of the parent activity code of this activity code in the hierarchy.
 void setSequenceNumber(int i)
          Sets the sequence number for sorting.
 java.lang.String toString()
          Returns a string representation of the object.
 void update()
          Updates this ActivityCode object in the database.
static void update(Session session, ActivityCode[] activitycodes)
          Updates multiple ActivityCode objects in the database.
 
Methods inherited from class com.primavera.integration.client.bo.BusinessObject
equals, hashCode, isNull, setNull
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ActivityCode

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

ActivityCode

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

ActivityCode

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

create

public ObjectId create()
                throws ServerException,
                       NetworkException,
                       BusinessObjectException
Creates this ActivityCode object in the database.

Returns:
ObjectId the unique ID of the newly created 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

create

public static ObjectId[] create(Session session,
                                ActivityCode[] activitycodes)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple ActivityCode objects in the database.

Parameters:
session - the Session object
activitycodes - array of ActivityCode objects to create
Returns:
ObjectId[] the array of unique IDs of newly created ActivityCode 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 ActivityCode load(Session session,
                                java.lang.String[] fields,
                                ObjectId objId)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Loads a single ActivityCode object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the ActivityCode object
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

load

public static BOIterator<ActivityCode> load(Session session,
                                            java.lang.String[] fields,
                                            ObjectId[] objIds)
                                     throws ServerException,
                                            NetworkException,
                                            BusinessObjectException
Loads multiple ActivityCode objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the ActivityCode 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 ActivityCode 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,
                          ActivityCode[] activitycodes)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple ActivityCode objects in the database.

Parameters:
session - the Session object
activitycodes - array of ActivityCode 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 ActivityCode 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,
                          ActivityCode[] activitycodes)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple ActivityCode objects from the database.

Parameters:
session - the Session object
activitycodes - array of ActivityCode 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

loadParentActivityCode

public ActivityCode loadParentActivityCode(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

createActivityCodeChild

public ObjectId createActivityCodeChild(ActivityCode activitycodechild)
                                 throws ServerException,
                                        NetworkException,
                                        BusinessObjectException
Creates an associated ActivityCode object in the database.

Parameters:
activitycodechild - ActivityCodeChild object to create
Returns:
ObjectId unique ID of the newly created 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

createActivityCodeChildren

public ObjectId[] createActivityCodeChildren(ActivityCode[] activitycodechildren)
                                      throws ServerException,
                                             NetworkException,
                                             BusinessObjectException
Creates multiple associated ActivityCode objects in the database.

Parameters:
activitycodechildren - array of ActivityCodeChild objects to create
Returns:
ObjectId[] array of object ids of newly created ActivityCode 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

loadActivityCodeChildren

public BOIterator<ActivityCode> loadActivityCodeChildren(java.lang.String[] fields,
                                                         java.lang.String sWhereClause,
                                                         java.lang.String sOrderBy)
                                                  throws ServerException,
                                                         NetworkException,
                                                         BusinessObjectException
Loads multiple associated ActivityCode objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
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

loadActivityCodeAssignments

public BOIterator<ActivityCodeAssignment> loadActivityCodeAssignments(java.lang.String[] fields,
                                                                      java.lang.String sWhereClause,
                                                                      java.lang.String sOrderBy)
                                                               throws ServerException,
                                                                      NetworkException,
                                                                      BusinessObjectException
Loads multiple associated ActivityCodeAssignment objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
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

loadActivities

public BOIterator<Activity> loadActivities(java.lang.String[] fields,
                                           java.lang.String sWhereClause,
                                           java.lang.String sOrderBy)
                                    throws ServerException,
                                           NetworkException,
                                           BusinessObjectException
Load the Activity objects to which this activity code is assigned.

Overrides:
loadActivities in class com.primavera.integration.client.bo.base.ActivityCodeBase
Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order by clause
Returns:
iterator of Activity 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

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the unique ID generated by the system.

Overrides:
getObjectId in class BusinessObject
Returns:
the value in the field ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setObjectId

public void setObjectId(ObjectId o)
                 throws BusinessObjectException
Sets the unique ID generated by the system.

Overrides:
setObjectId in class BusinessObject
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 project ID of the parent code type for this code if code type scope is 'Project' or 'EPS', null for code types with scope 'Global'. 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

getParentObjectId

public ObjectId getParentObjectId()
                           throws BusinessObjectException
Gets the unique ID of the parent activity code of this activity code in the hierarchy. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Returns:
the value in the field ParentObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setParentObjectId

public void setParentObjectId(ObjectId o)
                       throws BusinessObjectException
Sets the unique ID of the parent activity code of this activity code in the hierarchy. 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

getCodeTypeObjectId

public ObjectId getCodeTypeObjectId()
                             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. 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 CodeTypeObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setCodeTypeObjectId

public void setCodeTypeObjectId(ObjectId o)
                         throws BusinessObjectException
Sets 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. 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

getCodeTypeName

public java.lang.String getCodeTypeName()
                                 throws BusinessObjectException
Gets the name of the parent code type for this code.

Returns:
the value in the field CodeTypeName
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getDescription

public java.lang.String getDescription()
                                throws BusinessObjectException
Gets the description of the activity code.

Returns:
the value in the field Description
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setDescription

public void setDescription(java.lang.String s)
                    throws BusinessObjectException
Sets the description of the activity code.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCodeValue

public java.lang.String getCodeValue()
                              throws BusinessObjectException
Gets the value of the activity code. 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 CodeValue
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setCodeValue

public void setCodeValue(java.lang.String s)
                  throws BusinessObjectException
Sets the value of the activity code. This field must contain a valid value in order to create this type of business object in the database.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getSequenceNumber

public int getSequenceNumber()
                      throws BusinessObjectException
Gets the sequence number for sorting.

Returns:
the value in the field SequenceNumber
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setSequenceNumber

public void setSequenceNumber(int i)
                       throws BusinessObjectException
Sets the sequence number for sorting.

Parameters:
i - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCodeTypeScope

public ActivityCodeTypeScope getCodeTypeScope()
                                       throws BusinessObjectException
Gets the scope of the parent 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 CodeTypeScope
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this activity code 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 activity code 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 activity code.

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 activity code.

Returns:
the value in the field LastUpdateUser
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.