|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.ActivityCodeType
public class ActivityCodeType
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 |
---|
public ActivityCodeType(Session session)
session
- the Sessionpublic ActivityCodeType(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ActivityCodeType(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
session
- the SessionrowSet
- the PrmRowSet retrieved from the serveriIndex
- the row index in the PrmRowSet associated with this business object
BusinessObjectException
- if a problem occurred in the client-side business objectsMethod Detail |
---|
public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
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 objectspublic static ObjectId[] create(Session session, ActivityCodeType[] activitycodetypes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectactivitycodetypes
- array of ActivityCodeType objects to create
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 objectspublic static ActivityCodeType load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ActivityCodeType object
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 objectspublic static BOIterator<ActivityCodeType> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ActivityCodeType objects
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 objectspublic void update() throws ServerException, NetworkException, BusinessObjectException
update
in class BOBase
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 objectspublic static void update(Session session, ActivityCodeType[] activitycodetypes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectactivitycodetypes
- array of ActivityCodeType objects to update
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 objectspublic void delete() throws ServerException, NetworkException, BusinessObjectException
delete
in class BOBase
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 objectspublic static void delete(Session session, ActivityCodeType[] activitycodetypes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectactivitycodetypes
- array of ActivityCodeType objects to delete
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 objectspublic BOIterator<ActivityCode> loadRootActivityCodes(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic BOIterator<ActivityCode> loadAllActivityCodes(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
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 objectspublic BOIterator<ActivityCodeAssignment> loadActivityCodeAssignments(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
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@Deprecated public static java.lang.String getCodeValueObjectIdFieldName(ObjectId codeTypeObjectId)
codeTypeObjectId
- unique ID of an ActivityCodeType
@Deprecated public java.lang.String getCodeValueObjectIdFieldName() throws BusinessObjectException
BusinessObjectException
- if the ObjectId field(s) were not loaded in this business
object@Deprecated public static java.lang.String getCodeValueFieldName(ObjectId codeTypeObjectId)
codeTypeObjectId
- unique ID of an ActivityCodeType
@Deprecated public java.lang.String getCodeValueFieldName() throws BusinessObjectException
BusinessObjectException
- if the ObjectId field(s) were not loaded in this business
object@Deprecated public static ObjectId parseCodeValueObjectIdFieldName(java.lang.String sFieldName) throws InvalidFieldException
sFieldName
- code ObjectId field name
InvalidFieldException
@Deprecated public static ObjectId parseCodeValueFieldName(java.lang.String sFieldName) throws InvalidFieldException
sFieldName
- code value field name
InvalidFieldException
public ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setObjectId(ObjectId o) throws BusinessObjectException
setObjectId
in class BusinessObject
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getProjectObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setProjectObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getEPSObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setEPSObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setName(java.lang.String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getSequenceNumber() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setSequenceNumber(int i) throws BusinessObjectException
i
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getLength() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setLength(int i) throws BusinessObjectException
i
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsSecureCode() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setIsSecureCode(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ActivityCodeTypeScope getScope() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setScope(ActivityCodeTypeScope enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getCreateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getLastUpdateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getCreateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getLastUpdateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsBaseline() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static java.lang.String[] getRequiredCreateFields()
public static java.lang.String[] getFilterableFields()
public static java.lang.String[] getInternalDefaultLoadFields()
public static java.lang.String[] getAllFields()
public static java.lang.String[] getInternalAllFields()
public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
public static java.lang.String[] getWritableFields()
public static java.lang.String[] getDefaultXMLExportFields()
public static java.lang.String[] getMinimumXMLExportFields()
public java.lang.String toString()
toString
in class java.lang.Object
|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |