|
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.base.ProjectCodeBase
com.primavera.integration.client.bo.object.ProjectCode
public class ProjectCode
Project codes are user-defined codes to classify and categorize projects across the enterprise. They are defined globally. Project codes are hierarchical objects.
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 ProjectCode fields
Constructor Summary | |
---|---|
ProjectCode(Session session)
Class constructor specifying the Session. |
|
ProjectCode(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
ProjectCode(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 ProjectCode object in the database. |
static ObjectId[] |
create(Session session,
ProjectCode[] projectcodes)
Creates multiple ProjectCode objects in the database. |
ObjectId |
createProjectCodeChild(ProjectCode projectcodechild)
Creates an associated ProjectCode object in the database. |
ObjectId[] |
createProjectCodeChildren(ProjectCode[] projectcodechildren)
Creates multiple associated ProjectCode objects in the database. |
void |
delete()
Deletes this ProjectCode object from the database. |
static void |
delete(Session session,
ProjectCode[] projectcodes)
Deletes multiple ProjectCode 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 project code type. |
java.lang.String |
getCodeValue()
Gets the value of the project code. |
java.util.Date |
getCreateDate()
Gets the date this project code was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this project 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 project 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 project code was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this project 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 project code of this project code in the hierarchy. |
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 code value. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static ProjectCode |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single ProjectCode object from the database. |
static BOIterator<ProjectCode> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple ProjectCode objects from the database. |
ProjectCode |
loadParentProjectCode(java.lang.String[] fields)
Loads an associated ProjectCode object 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> |
loadProjectCodeChildren(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated ProjectCode objects from the database. |
ProjectCodeType |
loadProjectCodeType(java.lang.String[] fields)
Loads an associated ProjectCodeType object from the database. |
ProjectCodeUser |
loadProjectCodeUser(java.lang.String[] fields)
Loads an associated ProjectCodeUser object from the database. |
BOIterator<Project> |
loadProjects(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Load the Project objects to which this project code is assigned. |
void |
setCodeTypeObjectId(ObjectId o)
Sets the unique ID of the parent project code type. |
void |
setCodeValue(java.lang.String s)
Sets the value of the project code. |
void |
setDescription(java.lang.String s)
Sets the description of the project code. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setParentObjectId(ObjectId o)
Sets the unique ID of the parent project code of this project code in the hierarchy. |
void |
setSequenceNumber(int i)
Sets the sequence number for sorting. |
void |
setWeight(double d)
Sets the weight for this code value. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this ProjectCode object in the database. |
static void |
update(Session session,
ProjectCode[] projectcodes)
Updates multiple ProjectCode 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 ProjectCode(Session session)
session
- the Sessionpublic ProjectCode(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ProjectCode(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, ProjectCode[] projectcodes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectcodes
- array of ProjectCode 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 ProjectCode load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ProjectCode 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<ProjectCode> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ProjectCode 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, ProjectCode[] projectcodes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectcodes
- array of ProjectCode 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, ProjectCode[] projectcodes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectcodes
- array of ProjectCode 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 ProjectCodeType loadProjectCodeType(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 ProjectCode loadParentProjectCode(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 ObjectId createProjectCodeChild(ProjectCode projectcodechild) throws ServerException, NetworkException, BusinessObjectException
projectcodechild
- ProjectCodeChild object 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 ObjectId[] createProjectCodeChildren(ProjectCode[] projectcodechildren) throws ServerException, NetworkException, BusinessObjectException
projectcodechildren
- array of ProjectCodeChild 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 BOIterator<ProjectCode> loadProjectCodeChildren(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 objectspublic ProjectCodeUser loadProjectCodeUser(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<Project> loadProjects(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
loadProjects
in class com.primavera.integration.client.bo.base.ProjectCodeBase
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order by clause
ServerException
NetworkException
BusinessObjectException
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 getParentObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setParentObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getCodeTypeObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setCodeTypeObjectId(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 getCodeTypeName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getDescription() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDescription(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 java.lang.String getCodeValue() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setCodeValue(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 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 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 |