|
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.ResourceCodeType
public class ResourceCodeType
Resource code types provide a way of classifying resource codes. Resource codes are user-defined codes to classify and categorize resources across the enterprise. They are defined globally.
With potentially hundreds of resources being used across an enterprise of projects, codes provide another method for filtering the resources you need to access quickly, or for grouping resources for analysis and summarization in layouts. You can also use resource codes to group, sort, and filter resources in profiles and spreadsheets.
See Also: Quick reference of ResourceCodeType fields
Constructor Summary | |
---|---|
ResourceCodeType(Session session)
Class constructor specifying the Session. |
|
ResourceCodeType(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
ResourceCodeType(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 ResourceCodeType object in the database. |
static ObjectId[] |
create(Session session,
ResourceCodeType[] resourcecodetypes)
Creates multiple ResourceCodeType objects in the database. |
void |
delete()
Deletes this ResourceCodeType object from the database. |
static void |
delete(Session session,
ResourceCodeType[] resourcecodetypes)
Deletes multiple ResourceCodeType 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 resource code assignments using the ResourceCodeAssignment business object. |
static java.lang.String |
getCodeValueFieldName(ObjectId codeTypeObjectId)
Deprecated. As of release 5.0 SP3, create, load or update resource code assignments using the ResourceCodeAssignment business object. |
java.lang.String |
getCodeValueObjectIdFieldName()
Deprecated. As of release 5.0 SP3, create, load or update resource code assignments using the ResourceCodeAssignment business object. |
static java.lang.String |
getCodeValueObjectIdFieldName(ObjectId codeTypeObjectId)
Deprecated. As of release 5.0 SP3, create, load or update resource code assignments using the ResourceCodeAssignment business object. |
java.util.Date |
getCreateDate()
Gets the date this resource code type was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this resource 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 Resource Code Type. |
java.util.Date |
getLastUpdateDate()
Gets the date this resource code type was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this resource code type. |
int |
getLength()
Gets the maximum number of characters allowed for values of this resource 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 resource 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. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static ResourceCodeType |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single ResourceCodeType object from the database. |
static BOIterator<ResourceCodeType> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple ResourceCodeType objects from the database. |
BOIterator<ResourceCode> |
loadAllResourceCodes(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated ResourceCode objects from the database. |
BOIterator<ResourceCodeAssignment> |
loadResourceCodeAssignments(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated ResourceCodeAssignment objects from the database. |
BOIterator<ResourceCode> |
loadRootResourceCodes(java.lang.String[] fields)
Loads all root ResourceCode objects from the database. |
static ObjectId |
parseCodeValueFieldName(java.lang.String sFieldName)
Deprecated. As of release 5.0 SP3, create, load or update resource code assignments using the ResourceCodeAssignment business object. |
static ObjectId |
parseCodeValueObjectIdFieldName(java.lang.String sFieldName)
Deprecated. As of release 5.0 SP3, create, load or update resource code assignments using the ResourceCodeAssignment business object. |
void |
setIsSecureCode(boolean b)
Sets the flag indicating whether this is a secure Resource Code Type. |
void |
setLength(int i)
Sets the maximum number of characters allowed for values of this resource code. |
void |
setName(java.lang.String s)
Sets the name of the resource code type. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
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 ResourceCodeType object in the database. |
static void |
update(Session session,
ResourceCodeType[] resourcecodetypes)
Updates multiple ResourceCodeType 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 ResourceCodeType(Session session)
session
- the Sessionpublic ResourceCodeType(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ResourceCodeType(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, ResourceCodeType[] resourcecodetypes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectresourcecodetypes
- array of ResourceCodeType 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 ResourceCodeType load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ResourceCodeType 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<ResourceCodeType> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ResourceCodeType 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, ResourceCodeType[] resourcecodetypes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectresourcecodetypes
- array of ResourceCodeType 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, ResourceCodeType[] resourcecodetypes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectresourcecodetypes
- array of ResourceCodeType 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<ResourceCode> loadRootResourceCodes(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<ResourceCode> loadAllResourceCodes(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<ResourceCodeAssignment> loadResourceCodeAssignments(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 ResourceCodeType
@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 ResourceCodeType
@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 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 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 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 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 |