Primavera Integration API 8.0

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

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

public class ResourceCodeType
extends BusinessObject

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 String[] getAllFields()
          Gets all fields for this business object.
 Date getCreateDate()
          Gets the date this resource code type was created.
 String getCreateUser()
          Gets the name of the user that created this resource code type.
static String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
static String[] getFilterableFields()
          Gets all fields that can be filtered.
static String[] getInternalAllFields()
          An internal method that should not be called directly by client code.
static Set<String> getInternalAllFieldsSet()
          An internal method that should not be called directly by client code.
static 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.
 Date getLastUpdateDate()
          Gets the date this resource code type was last updated.
 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 String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 String getName()
          Gets the name of the resource code type.
 ObjectId getObjectId()
          Gets the unique ID generated by the system.
static 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 String[] getWritableFields()
          Gets all writable fields for this business object.
static ResourceCodeType load(Session session, String[] fields, ObjectId objId)
          Loads a single ResourceCodeType object from the database.
static BOIterator<ResourceCodeType> load(Session session, String[] fields, ObjectId[] objIds)
          Loads multiple ResourceCodeType objects from the database.
 BOIterator<ResourceCode> loadAllResourceCodes(String[] fields, String sWhereClause, String sOrderBy)
          Loads multiple associated ResourceCode objects from the database.
 BOIterator<ResourceCodeAssignment> loadResourceCodeAssignments(String[] fields, String sWhereClause, String sOrderBy)
          Loads multiple associated ResourceCodeAssignment objects from the database.
 BOIterator<ResourceCode> loadRootResourceCodes(String[] fields)
          Loads all root ResourceCode objects from the database.
 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(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.
 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

ResourceCodeType

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

ResourceCodeType

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

ResourceCodeType

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

loadRootResourceCodes

public BOIterator<ResourceCode> loadRootResourceCodes(String[] fields)
                                               throws ServerException,
                                                      NetworkException,
                                                      BusinessObjectException
Loads all root ResourceCode 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

loadAllResourceCodes

public BOIterator<ResourceCode> loadAllResourceCodes(String[] fields,
                                                     String sWhereClause,
                                                     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(String[] fields,
                                                                      String sWhereClause,
                                                                      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

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

getName

public String getName()
               throws BusinessObjectException
Gets the name of the resource 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(String s)
             throws BusinessObjectException
Sets the name of the resource 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

getLength

public int getLength()
              throws BusinessObjectException
Gets the maximum number of characters allowed for values of this resource 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 resource code.

Parameters:
i - 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 Resource 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 Resource 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 Date getCreateDate()
                   throws BusinessObjectException
Gets the date this resource 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 Date getLastUpdateDate()
                       throws BusinessObjectException
Gets the date this resource 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 String getCreateUser()
                     throws BusinessObjectException
Gets the name of the user that created this resource code type.

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

getLastUpdateUser

public String getLastUpdateUser()
                         throws BusinessObjectException
Gets the name of the user that last updated this resource code type.

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

getRequiredCreateFields

public static 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 String[] getFilterableFields()
Gets all fields that can be filtered.

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

public static String[] getInternalDefaultLoadFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getAllFields

public static String[] getAllFields()
Gets all fields for this business object.

Returns:
String[] an array of all fields

getInternalAllFields

public static String[] getInternalAllFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getInternalAllFieldsSet

public static Set<String> getInternalAllFieldsSet()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getWritableFields

public static String[] getWritableFields()
Gets all writable fields for this business object.

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

public static 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 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 String toString()
Returns a string representation of the object. The output is in XML.

Overrides:
toString in class Object
Returns:
String a string representation of the object.

create

public ObjectId create()
                throws ServerException,
                       NetworkException,
                       BusinessObjectException
Creates this ResourceCodeType object in the database.

Returns:
ObjectId the unique ID of the newly created 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

create

public static ObjectId[] create(Session session,
                                ResourceCodeType[] resourcecodetypes)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple ResourceCodeType objects in the database.

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

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the ResourceCodeType object
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

load

public static BOIterator<ResourceCodeType> load(Session session,
                                                String[] fields,
                                                ObjectId[] objIds)
                                         throws ServerException,
                                                NetworkException,
                                                BusinessObjectException
Loads multiple ResourceCodeType objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the ResourceCodeType 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 ResourceCodeType object in the database.

Overrides:
update in class com.primavera.integration.client.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,
                          ResourceCodeType[] resourcecodetypes)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple ResourceCodeType objects in the database.

Parameters:
session - the Session object
resourcecodetypes - array of ResourceCodeType 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 ResourceCodeType object from the database.

Overrides:
delete in class com.primavera.integration.client.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,
                          ResourceCodeType[] resourcecodetypes)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple ResourceCodeType objects from the database.

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

Primavera Integration API 8.0

Copyright © 2003, 2010, Oracle and/or its affiliates. All rights reserved.