Primavera Integration API 7.0

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

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.ActivityCodeType

public class ActivityCodeType
extends BusinessObject

Activity code types provide a way of classifying activity codes. Activity codes are user-defined codes to classify and categorize activities according to the organization's and project's needs.

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 activity codes at three different scopes: 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 and project activity codes and values to activities only in the EPS and project for which the codes were created. Each ActivityCode can have an unlimited number of values. You can change the scope of an ActivityCodeType from project to EPS, project to Global, and EPS to global. However, you cannot change the scope from EPS to project or from global to anything else. Within the EPS scope, you can always move an ActivityCodeType to a higher level in the EPS structure. However, moving it to a lower level or outside of the EPS hierarchy is possible only if the ActivityCodeType's values are not assigned to any activities. If the ActivityCodeType value assignment exists, an exception will be thrown. When changing scope, you must also change the associated parent ObjectId using setProjectObjectId(ObjectId) or setEPSObjectId(ObjectId). If the scope and the parent ObjectId don't match, an exception will be thrown during the update().

See Also:   Quick reference of ActivityCodeType fields


Constructor Summary
ActivityCodeType(Session session)
          Class constructor specifying the Session.
ActivityCodeType(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
ActivityCodeType(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 ActivityCodeType object in the database.
static ObjectId[] create(Session session, ActivityCodeType[] activitycodetypes)
          Creates multiple ActivityCodeType objects in the database.
 void delete()
          Deletes this ActivityCodeType object from the database.
static void delete(Session session, ActivityCodeType[] activitycodetypes)
          Deletes multiple ActivityCodeType objects from the database.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 java.lang.String getCodeValueFieldName()
          Deprecated. As of release 5.0 SP3, create, load or update activity code assignments using the ActivityCodeAssignment business object.
static java.lang.String getCodeValueFieldName(ObjectId codeTypeObjectId)
          Deprecated. As of release 5.0 SP3, create, load or update activity code assignments using the ActivityCodeAssignment business object.
 java.lang.String getCodeValueObjectIdFieldName()
          Deprecated. As of release 5.0 SP3, create, load or update activity code assignments using the ActivityCodeAssignment business object.
static java.lang.String getCodeValueObjectIdFieldName(ObjectId codeTypeObjectId)
          Deprecated. As of release 5.0 SP3, create, load or update activity code assignments using the ActivityCodeAssignment business object.
 java.util.Date getCreateDate()
          Gets the date this Activity Code Type was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this ActivityCodeType.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
 ObjectId getEPSObjectId()
          Gets the unique ID of the associated EPS.
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.
 boolean getIsSecureCode()
          Gets the flag indicating whether this is a secure Activity Code Type.
 java.util.Date getLastUpdateDate()
          Gets the date this Activity Code Type was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this ActivityCodeType.
 int getLength()
          Gets the maximum number of characters allowed for values of this activity code.
static java.lang.String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 java.lang.String getName()
          Gets the name of the activity code type.
 ObjectId getObjectId()
          Gets the unique ID generated by the system.
 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.
 ActivityCodeTypeScope getScope()
          Gets the scope of the code type: Global, EPS, or Project.
 int getSequenceNumber()
          Gets the sequence number for sorting.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static ActivityCodeType load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single ActivityCodeType object from the database.
static BOIterator<ActivityCodeType> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple ActivityCodeType objects from the database.
 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> loadAllActivityCodes(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityCode objects from the database.
 BOIterator<ActivityCode> loadRootActivityCodes(java.lang.String[] fields)
          Loads all root ActivityCode objects from the database.
static ObjectId parseCodeValueFieldName(java.lang.String sFieldName)
          Deprecated. As of release 5.0 SP3, create, load or update activity code assignments using the ActivityCodeAssignment business object.
static ObjectId parseCodeValueObjectIdFieldName(java.lang.String sFieldName)
          Deprecated. As of release 5.0 SP3, create, load or update activity code assignments using the ActivityCodeAssignment business object.
 void setEPSObjectId(ObjectId o)
          Sets the unique ID of the associated EPS.
 void setIsSecureCode(boolean b)
          Sets the flag indicating whether this is a secure Activity Code Type.
 void setLength(int i)
          Sets the maximum number of characters allowed for values of this activity code.
 void setName(java.lang.String s)
          Sets the name of the activity code type.
 void setObjectId(ObjectId o)
          Sets the unique ID generated by the system.
 void setProjectObjectId(ObjectId o)
          Sets the unique ID of the associated project.
 void setScope(ActivityCodeTypeScope enm)
          Sets the scope of the code type: Global, EPS, or Project.
 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 ActivityCodeType object in the database.
static void update(Session session, ActivityCodeType[] activitycodetypes)
          Updates multiple ActivityCodeType 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

ActivityCodeType

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

ActivityCodeType

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

ActivityCodeType

public ActivityCodeType(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 ActivityCodeType object in the database.

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

create

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

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

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

load

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

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

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

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

loadRootActivityCodes

public BOIterator<ActivityCode> loadRootActivityCodes(java.lang.String[] fields)
                                               throws ServerException,
                                                      NetworkException,
                                                      BusinessObjectException
Loads all root ActivityCode objects from the database.

Parameters:
fields - fields to load
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

loadAllActivityCodes

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

getCodeValueObjectIdFieldName

@Deprecated
public static java.lang.String getCodeValueObjectIdFieldName(ObjectId codeTypeObjectId)
Deprecated. As of release 5.0 SP3, create, load or update activity code assignments using the ActivityCodeAssignment business object.

Return the activity code ObjectId field name that can be used in the field name array when loading an Activity.

Parameters:
codeTypeObjectId - unique ID of an ActivityCodeType
Returns:
activity code ObjectId field name

getCodeValueObjectIdFieldName

@Deprecated
public java.lang.String getCodeValueObjectIdFieldName()
                                               throws BusinessObjectException
Deprecated. As of release 5.0 SP3, create, load or update activity code assignments using the ActivityCodeAssignment business object.

Gets the activity code ObjectId field name that can be used in the field name array when loading an Activity.

Returns:
activity code ObjectId field name
Throws:
BusinessObjectException - if the ObjectId field(s) were not loaded in this business object

getCodeValueFieldName

@Deprecated
public static java.lang.String getCodeValueFieldName(ObjectId codeTypeObjectId)
Deprecated. As of release 5.0 SP3, create, load or update activity code assignments using the ActivityCodeAssignment business object.

Return the activity code value field name that can be used in the field name array when loading an Activity.

Parameters:
codeTypeObjectId - unique ID of an ActivityCodeType
Returns:
activity code value field name

getCodeValueFieldName

@Deprecated
public java.lang.String getCodeValueFieldName()
                                       throws BusinessObjectException
Deprecated. As of release 5.0 SP3, create, load or update activity code assignments using the ActivityCodeAssignment business object.

Gets the activity code value field name that can be used in the field name array when loading an Activity.

Returns:
activity code value field name
Throws:
BusinessObjectException - if the ObjectId field(s) were not loaded in this business object

parseCodeValueObjectIdFieldName

@Deprecated
public static ObjectId parseCodeValueObjectIdFieldName(java.lang.String sFieldName)
                                                throws InvalidFieldException
Deprecated. As of release 5.0 SP3, create, load or update activity code assignments using the ActivityCodeAssignment business object.

Return the ObjectId of the ActivityCodeType.

Parameters:
sFieldName - code ObjectId field name
Returns:
unique ID of the ActivityCodeType
Throws:
InvalidFieldException

parseCodeValueFieldName

@Deprecated
public static ObjectId parseCodeValueFieldName(java.lang.String sFieldName)
                                        throws InvalidFieldException
Deprecated. As of release 5.0 SP3, create, load or update activity code assignments using the ActivityCodeAssignment business object.

Return the unique ID of the ActivityCodeType.

Parameters:
sFieldName - code value field name
Returns:
unique ID of the ActivityCodeType
Throws:
InvalidFieldException

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 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

setProjectObjectId

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

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

getEPSObjectId

public ObjectId getEPSObjectId()
                        throws BusinessObjectException
Gets the unique ID of the associated EPS. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setEPSObjectId

public void setEPSObjectId(ObjectId o)
                    throws BusinessObjectException
Sets the unique ID of the associated EPS. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getName

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

setName

public void setName(java.lang.String s)
             throws BusinessObjectException
Sets the name of the activity code type. 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

getLength

public int getLength()
              throws BusinessObjectException
Gets the maximum number of characters allowed for values of this activity code.

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

setLength

public void setLength(int i)
               throws BusinessObjectException
Sets the maximum number of characters allowed for values of this activity code.

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

getIsSecureCode

public boolean getIsSecureCode()
                        throws BusinessObjectException
Gets the flag indicating whether this is a secure Activity Code Type.

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

setIsSecureCode

public void setIsSecureCode(boolean b)
                     throws BusinessObjectException
Sets the flag indicating whether this is a secure Activity Code Type.

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

getScope

public ActivityCodeTypeScope getScope()
                               throws BusinessObjectException
Gets the scope of the 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. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setScope

public void setScope(ActivityCodeTypeScope enm)
              throws BusinessObjectException
Sets the scope of the 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. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Parameters:
enm - the value to set this field to
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 Type 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 Type 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 ActivityCodeType.

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 ActivityCodeType.

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.