Primavera Integration API 7.0

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

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

public class ProjectCodeType
extends BusinessObject

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

ProjectCodeType

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

ProjectCodeType

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

ProjectCodeType

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

Returns:
ObjectId the unique ID of the newly created ProjectCodeType 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,
                                ProjectCodeType[] projectcodetypes)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple ProjectCodeType objects in the database.

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

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the ProjectCodeType object
Returns:
ProjectCodeType the ProjectCodeType 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<ProjectCodeType> load(Session session,
                                               java.lang.String[] fields,
                                               ObjectId[] objIds)
                                        throws ServerException,
                                               NetworkException,
                                               BusinessObjectException
Loads multiple ProjectCodeType objects from the database.

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

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

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

loadRootProjectCodes

public BOIterator<ProjectCode> loadRootProjectCodes(java.lang.String[] fields)
                                             throws ServerException,
                                                    NetworkException,
                                                    BusinessObjectException
Loads all root ProjectCode 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

loadAllProjectCodes

public BOIterator<ProjectCode> loadAllProjectCodes(java.lang.String[] fields,
                                                   java.lang.String sWhereClause,
                                                   java.lang.String sOrderBy)
                                            throws ServerException,
                                                   NetworkException,
                                                   BusinessObjectException
Loads multiple associated ProjectCode 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

loadProjectCodeAssignments

public BOIterator<ProjectCodeAssignment> loadProjectCodeAssignments(java.lang.String[] fields,
                                                                    java.lang.String sWhereClause,
                                                                    java.lang.String sOrderBy)
                                                             throws ServerException,
                                                                    NetworkException,
                                                                    BusinessObjectException
Loads multiple associated ProjectCodeAssignment 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 project code assignments using the ProjectCodeAssignment business object.

Return the project code ObjectId field name that can be used in the field name array when loading a Project.

Parameters:
codeTypeObjectId - unique ID of a ProjectCodeType
Returns:
project code ObjectId field name

getCodeValueObjectIdFieldName

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

Gets the project code ObjectId field name that can be used in the field name array when loading a Project.

Returns:
project 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 project code assignments using the ProjectCodeAssignment business object.

Gets the project code ObjectId field name that can be used in the field name array when loading a Project.

Parameters:
codeTypeObjectId - unique ID of a ProjectCodeType
Returns:
project code value field name

getCodeValueFieldName

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

Gets the project code value field name that can be used in the field name array when loading a Project.

Returns:
project 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 project code assignments using the ProjectCodeAssignment business object.

Return the unique ID of the ProjectCodeType.

Parameters:
sFieldName - code ObjectId field name
Returns:
unique ID of the ProjectCodeType
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 project code assignments using the ProjectCodeAssignment business object.

Return the unique ID of the ProjectCodeType.

Parameters:
sFieldName - code value field name
Returns:
unique ID of the ProjectCodeType
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

getName

public java.lang.String getName()
                         throws BusinessObjectException
Gets the name of the project 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 project 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 project 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 project code.

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

getWeight

public double getWeight()
                 throws BusinessObjectException
Gets the weight for this project code type.

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

setWeight

public void setWeight(double d)
               throws BusinessObjectException
Sets the weight for this project code type.

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

getMaxCodeValueWeight

public double getMaxCodeValueWeight()
                             throws BusinessObjectException
Gets the maximum weight of the code values for this project code type.

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

setMaxCodeValueWeight

public void setMaxCodeValueWeight(double d)
                           throws BusinessObjectException
Sets the maximum weight of the code values for this project code type.

Parameters:
d - 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 Project 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 Project Code Type.

Parameters:
b - 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 project 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 project 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 project code type.

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 project code type.

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.