|
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.ProjectCodeType
public class ProjectCodeType
Project code types provide a way of classifying project codes. Project codes are user-defined codes to classify and categorize projects across the enterprise. They are defined globally.
You can organize the projects in your EPS in groups according to specific categories, such as location and manager, using project codes. You can define unlimited hierarchical project codes to fulfill the filtering, sorting, and reporting requirements for your projects, and arrange them hierarchically for easier management and assignment.
The Project Codes dictionary is global to the entire enterprise. Assign a project code value to projects for each project code you create.
Use project codes to group projects, consolidate large amounts of information, and to distinguish one project from another. All projects assigned a value for a code are grouped by their corresponding values when you group and sort by project code in the Project Management application.
See Also: Quick reference of ProjectCodeType fields
Constructor Summary | |
---|---|
ProjectCodeType(Session session)
Class constructor specifying the Session. |
|
ProjectCodeType(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
ProjectCodeType(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 ProjectCodeType object in the database. |
static ObjectId[] |
create(Session session,
ProjectCodeType[] projectcodetypes)
Creates multiple ProjectCodeType objects in the database. |
void |
delete()
Deletes this ProjectCodeType object from the database. |
static void |
delete(Session session,
ProjectCodeType[] projectcodetypes)
Deletes multiple ProjectCodeType 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 project code assignments using the ProjectCodeAssignment business object. |
static java.lang.String |
getCodeValueFieldName(ObjectId codeTypeObjectId)
Deprecated. As of release 5.0 SP3, create, load or update project code assignments using the ProjectCodeAssignment business object. |
java.lang.String |
getCodeValueObjectIdFieldName()
Deprecated. As of release 5.0 SP3, create, load or update project code assignments using the ProjectCodeAssignment business object. |
static java.lang.String |
getCodeValueObjectIdFieldName(ObjectId codeTypeObjectId)
Deprecated. As of release 5.0 SP3, create, load or update project code assignments using the ProjectCodeAssignment business object. |
java.util.Date |
getCreateDate()
Gets the date this project code type was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this project code type. |
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 |
getIsSecureCode()
Gets the flag indicating whether this is a secure Project Code Type. |
java.util.Date |
getLastUpdateDate()
Gets the date this project code type was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this project code type. |
int |
getLength()
Gets the maximum number of characters allowed for values of this project code. |
double |
getMaxCodeValueWeight()
Gets the maximum weight of the code values for this project code type. |
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 project code type. |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
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. |
double |
getWeight()
Gets the weight for this project code type. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static ProjectCodeType |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single ProjectCodeType object from the database. |
static BOIterator<ProjectCodeType> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple ProjectCodeType objects from the database. |
BOIterator<ProjectCode> |
loadAllProjectCodes(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated ProjectCode objects from the database. |
BOIterator<ProjectCodeAssignment> |
loadProjectCodeAssignments(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated ProjectCodeAssignment objects from the database. |
BOIterator<ProjectCode> |
loadRootProjectCodes(java.lang.String[] fields)
Loads all root ProjectCode objects from the database. |
static ObjectId |
parseCodeValueFieldName(java.lang.String sFieldName)
Deprecated. As of release 5.0 SP3, create, load or update project code assignments using the ProjectCodeAssignment business object. |
static ObjectId |
parseCodeValueObjectIdFieldName(java.lang.String sFieldName)
Deprecated. As of release 5.0 SP3, create, load or update project code assignments using the ProjectCodeAssignment business object. |
void |
setIsSecureCode(boolean b)
Sets the flag indicating whether this is a secure Project Code Type. |
void |
setLength(int i)
Sets the maximum number of characters allowed for values of this project code. |
void |
setMaxCodeValueWeight(double d)
Sets the maximum weight of the code values for this project code type. |
void |
setName(java.lang.String s)
Sets the name of the project code type. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setSequenceNumber(int i)
Sets the sequence number for sorting. |
void |
setWeight(double d)
Sets the weight for this project code type. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this ProjectCodeType object in the database. |
static void |
update(Session session,
ProjectCodeType[] projectcodetypes)
Updates multiple ProjectCodeType 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 ProjectCodeType(Session session)
session
- the Sessionpublic ProjectCodeType(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ProjectCodeType(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, ProjectCodeType[] projectcodetypes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectcodetypes
- array of ProjectCodeType 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 ProjectCodeType load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ProjectCodeType 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<ProjectCodeType> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ProjectCodeType 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, ProjectCodeType[] projectcodetypes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectcodetypes
- array of ProjectCodeType 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, ProjectCodeType[] projectcodetypes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectcodetypes
- array of ProjectCodeType 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<ProjectCode> loadRootProjectCodes(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<ProjectCode> loadAllProjectCodes(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<ProjectCodeAssignment> loadProjectCodeAssignments(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 a ProjectCodeType
@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 a ProjectCodeType
@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 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 double getWeight() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setWeight(double d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getMaxCodeValueWeight() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setMaxCodeValueWeight(double d) throws BusinessObjectException
d
- 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 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 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 |