Primavera Integration API 7.0

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

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.base.ResourceCodeBase
              extended by com.primavera.integration.client.bo.object.ResourceCode

public class ResourceCode
extends com.primavera.integration.client.bo.base.ResourceCodeBase

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 ResourceCode fields


Constructor Summary
ResourceCode(Session session)
          Class constructor specifying the Session.
ResourceCode(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
ResourceCode(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 ResourceCode object in the database.
static ObjectId[] create(Session session, ResourceCode[] resourcecodes)
          Creates multiple ResourceCode objects in the database.
 ObjectId createResourceCodeChild(ResourceCode resourcecodechild)
          Creates an associated ResourceCode object in the database.
 ObjectId[] createResourceCodeChildren(ResourceCode[] resourcecodechildren)
          Creates multiple associated ResourceCode objects in the database.
 void delete()
          Deletes this ResourceCode object from the database.
static void delete(Session session, ResourceCode[] resourcecodes)
          Deletes multiple ResourceCode 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 resource code type.
 java.lang.String getCodeValue()
          Gets the value of the resource code.
 java.util.Date getCreateDate()
          Gets the date this resource code was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this resource 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 resource 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 resource code was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this resource 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 resource code of this resource 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.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static ResourceCode load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single ResourceCode object from the database.
static BOIterator<ResourceCode> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple ResourceCode objects from the database.
 ResourceCode loadParentResourceCode(java.lang.String[] fields)
          Loads an associated ResourceCode object 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> loadResourceCodeChildren(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ResourceCode objects from the database.
 ResourceCodeType loadResourceCodeType(java.lang.String[] fields)
          Loads an associated ResourceCodeType object from the database.
 BOIterator<Resource> loadResources(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Load the Resource objects to which this resource code is assigned.
 void setCodeTypeObjectId(ObjectId o)
          Sets the unique ID of the parent resource code type.
 void setCodeValue(java.lang.String s)
          Sets the value of the resource code.
 void setDescription(java.lang.String s)
          Sets the description of the resource code.
 void setObjectId(ObjectId o)
          Sets the unique ID generated by the system.
 void setParentObjectId(ObjectId o)
          Sets the unique ID of the parent resource code of this resource code in the hierarchy.
 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 ResourceCode object in the database.
static void update(Session session, ResourceCode[] resourcecodes)
          Updates multiple ResourceCode 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

ResourceCode

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

ResourceCode

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

ResourceCode

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

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

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

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

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

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

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

loadResourceCodeType

public ResourceCodeType loadResourceCodeType(java.lang.String[] fields)
                                      throws ServerException,
                                             NetworkException,
                                             BusinessObjectException
Loads an associated ResourceCodeType object from the database.

Parameters:
fields - fields to load
Returns:
ResourceCodeType the ResourceCodeType 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

loadParentResourceCode

public ResourceCode loadParentResourceCode(java.lang.String[] fields)
                                    throws ServerException,
                                           NetworkException,
                                           BusinessObjectException
Loads an associated ResourceCode object from the database.

Parameters:
fields - fields to load
Returns:
ResourceCode the ResourceCode 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

createResourceCodeChild

public ObjectId createResourceCodeChild(ResourceCode resourcecodechild)
                                 throws ServerException,
                                        NetworkException,
                                        BusinessObjectException
Creates an associated ResourceCode object in the database.

Parameters:
resourcecodechild - ResourceCodeChild object to create
Returns:
ObjectId unique ID of the newly created ResourceCode 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

createResourceCodeChildren

public ObjectId[] createResourceCodeChildren(ResourceCode[] resourcecodechildren)
                                      throws ServerException,
                                             NetworkException,
                                             BusinessObjectException
Creates multiple associated ResourceCode objects in the database.

Parameters:
resourcecodechildren - array of ResourceCodeChild objects to create
Returns:
ObjectId[] array of object ids of newly created ResourceCode 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

loadResourceCodeChildren

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

loadResourceCodeAssignments

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

loadResources

public BOIterator<Resource> loadResources(java.lang.String[] fields,
                                          java.lang.String sWhereClause,
                                          java.lang.String sOrderBy)
                                   throws ServerException,
                                          NetworkException,
                                          BusinessObjectException
Load the Resource objects to which this resource code is assigned.

Overrides:
loadResources in class com.primavera.integration.client.bo.base.ResourceCodeBase
Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order by clause
Returns:
iterator of Resource objects
Throws:
ServerException
NetworkException
BusinessObjectException

getCodeTypeObjectId

public ObjectId getCodeTypeObjectId()
                             throws BusinessObjectException
Gets the unique ID of the parent resource code type. This field is automatically loaded by default whenever this type of business object is loaded from the database. 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 CodeTypeObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setCodeTypeObjectId

public void setCodeTypeObjectId(ObjectId o)
                         throws BusinessObjectException
Sets the unique ID of the parent resource code type. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.

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

getParentObjectId

public ObjectId getParentObjectId()
                           throws BusinessObjectException
Gets the unique ID of the parent resource code of this resource code in the hierarchy. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setParentObjectId

public void setParentObjectId(ObjectId o)
                       throws BusinessObjectException
Sets the unique ID of the parent resource code of this resource code in the hierarchy. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

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

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

getCodeValue

public java.lang.String getCodeValue()
                              throws BusinessObjectException
Gets the value of the resource code. 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 CodeValue
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setCodeValue

public void setCodeValue(java.lang.String s)
                  throws BusinessObjectException
Sets the value of the resource code. 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

getDescription

public java.lang.String getDescription()
                                throws BusinessObjectException
Gets the description of the resource code.

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

setDescription

public void setDescription(java.lang.String s)
                    throws BusinessObjectException
Sets the description of the resource code.

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

getCodeTypeName

public java.lang.String getCodeTypeName()
                                 throws BusinessObjectException
Gets the name of the parent code type for this code.

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

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this resource code 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 resource code 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 resource code.

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 resource code.

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.