com.primavera.integration.client.bo.object

Class ResourceAssignmentCode

java.lang.Object

com.primavera.integration.client.BOBase

com.primavera.integration.client.bo.BusinessObject

com.primavera.integration.client.bo.base.ResourceAssignmentCodeBase

com.primavera.integration.client.bo.object.ResourceAssignmentCode

public class ResourceAssignmentCode
extends com.primavera.integration.client.bo.base.ResourceAssignmentCodeBase

Assignment codes are user-defined codes to classify and categorize assignments across the enterprise. They are defined globally.

With potentially hundreds of assignments being used across an enterprise of projects, codes provide another method for filtering the assignments you need to access quickly, or for grouping assignments for analysis and summarization in layouts. You can also use assignment codes to group, sort, and filter assignments in profiles and spreadsheets.

See Also: Quick reference of ResourceAssignmentCode fields

Constructor Summary

Constructors

Constructor and Description
ResourceAssignmentCode(Session session) Class constructor specifying the Session.
ResourceAssignmentCode(Session session, ObjectId objId) Class constructor specifying the Session and ObjectId of the object.
ResourceAssignmentCode(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) Class constructor called internally after objects are retrieved from the server.

Method Summary

Modifier and Type	Method and Description
ObjectId	create() Creates this ResourceAssignmentCode object in the database.
static ObjectId[]	create(Session session, ResourceAssignmentCode[] resourceassignmentcodes) Creates multiple ResourceAssignmentCode objects in the database.
ObjectId	createAssignmentCodeChild(ResourceAssignmentCode assignmentcodechild) Creates an associated ResourceAssignmentCode object in the database.
ObjectId[]	createAssignmentCodeChildren(ResourceAssignmentCode[] assignmentcodechildren) Creates multiple associated ResourceAssignmentCode objects in the database.
void	delete() Deletes this ResourceAssignmentCode object from the database.
static void	delete(Session session, ResourceAssignmentCode[] resourceassignmentcodes) Deletes multiple ResourceAssignmentCode objects from the database.
static String[]	getAllFields() Gets all fields for this business object.
String	getCodeTypeName() Gets the name of the parent code type for this code.
ObjectId	getCodeTypeObjectId() Gets the unique ID of the parent assignment code type.
String	getCodeValue() Gets the value of the assignment code.
Date	getCreateDate() Gets the date this assignment code was created.
String	getCreateUser() Gets the name of the user that created this assignment code.
static String[]	getDefaultXMLExportFields() Deprecated.
String	getDescription() Gets the description of the assignment code.
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.
Date	getLastUpdateDate() Gets the date this assignment code was last updated.
String	getLastUpdateUser() Gets the name of the user that last updated this assignment code.
static 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 assignment code of this assignment code in the hierarchy.
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 ResourceAssignmentCode	load(Session session, String[] fields, ObjectId objId) Loads a single ResourceAssignmentCode object from the database.
static BOIterator<ResourceAssignmentCode>	load(Session session, String[] fields, ObjectId[] objIds) Loads multiple ResourceAssignmentCode objects from the database.
BOIterator<ResourceAssignmentCode>	loadAssignmentCodeChildren(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ResourceAssignmentCode objects from the database.
ResourceAssignmentCode	loadParentAssignmentCode(String[] fields) Loads an associated ResourceAssignmentCode object from the database.
BOIterator<ResourceAssignmentCodeAssignment>	loadResourceAssignmentCodeAssignments(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ResourceAssignmentCodeAssignment objects from the database.
ResourceAssignmentCodeType	loadResourceAssignmentCodeType(String[] fields) Loads an associated ResourceAssignmentCodeType object from the database.
BOIterator<ResourceAssignment>	loadResourceAssignments(String[] fields, String sWhereClause, String sOrderBy) Load the Assignment objects to which this assignment code is assigned.
void	setCodeTypeObjectId(ObjectId o) Sets the unique ID of the parent assignment code type.
void	setCodeValue(String s) Sets the value of the assignment code.
void	setDescription(String s) Sets the description of the assignment code.
void	setObjectId(ObjectId o) Sets the unique ID generated by the system.
void	setParentObjectId(ObjectId o) Sets the unique ID of the parent assignment code of this assignment code in the hierarchy.
void	setSequenceNumber(int i) Sets the sequence number for sorting.
String	toString() Returns a string representation of the object.
void	update() Updates this ResourceAssignmentCode object in the database.
static void	update(Session session, ResourceAssignmentCode[] resourceassignmentcodes) Updates multiple ResourceAssignmentCode objects in the database.

Methods inherited from class com.primavera.integration.client.bo.BusinessObject

equals, getMaxFieldLength, getValue, getValue, hashCode, isNull, setEarlyDate, setNull

Methods inherited from class com.primavera.integration.client.BOBase

combineFields

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ResourceAssignmentCode

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

ResourceAssignmentCode

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

ResourceAssignmentCode

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

loadResourceAssignmentCodeType

public ResourceAssignmentCodeType loadResourceAssignmentCodeType(String[] fields)
                                                          throws ServerException,
                                                                 NetworkException,
                                                                 BusinessObjectException

Loads an associated ResourceAssignmentCodeType object from the database.

Parameters:

fields - fields to load

Returns:

ResourceAssignmentCodeType the ResourceAssignmentCodeType 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

loadParentAssignmentCode

public ResourceAssignmentCode loadParentAssignmentCode(String[] fields)
                                                throws ServerException,
                                                       NetworkException,
                                                       BusinessObjectException

Loads an associated ResourceAssignmentCode object from the database.

Parameters:

fields - fields to load

Returns:

ResourceAssignmentCode the ResourceAssignmentCode 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

createAssignmentCodeChild

public ObjectId createAssignmentCodeChild(ResourceAssignmentCode assignmentcodechild)
                                   throws ServerException,
                                          NetworkException,
                                          BusinessObjectException

Creates an associated ResourceAssignmentCode object in the database.

Parameters:

assignmentcodechild - AssignmentCodeChild object to create

Returns:

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

createAssignmentCodeChildren

public ObjectId[] createAssignmentCodeChildren(ResourceAssignmentCode[] assignmentcodechildren)
                                        throws ServerException,
                                               NetworkException,
                                               BusinessObjectException

Creates multiple associated ResourceAssignmentCode objects in the database.

Parameters:

assignmentcodechildren - array of AssignmentCodeChild objects to create

Returns:

ObjectId[] array of object ids of newly created ResourceAssignmentCode 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

loadAssignmentCodeChildren

public BOIterator<ResourceAssignmentCode> loadAssignmentCodeChildren(String[] fields,
                                                                     String sWhereClause,
                                                                     String sOrderBy)
                                                              throws ServerException,
                                                                     NetworkException,
                                                                     BusinessObjectException

Loads multiple associated ResourceAssignmentCode 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

loadResourceAssignmentCodeAssignments

public BOIterator<ResourceAssignmentCodeAssignment> loadResourceAssignmentCodeAssignments(String[] fields,
                                                                                          String sWhereClause,
                                                                                          String sOrderBy)
                                                                                   throws ServerException,
                                                                                          NetworkException,
                                                                                          BusinessObjectException

Loads multiple associated ResourceAssignmentCodeAssignment 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

loadResourceAssignments

public BOIterator<ResourceAssignment> loadResourceAssignments(String[] fields,
                                                              String sWhereClause,
                                                              String sOrderBy)
                                                       throws ServerException,
                                                              NetworkException,
                                                              BusinessObjectException

Load the Assignment objects to which this assignment code is assigned.

Overrides:

loadResourceAssignments in class com.primavera.integration.client.bo.base.ResourceAssignmentCodeBase

Parameters:

fields - fields to load

sWhereClause - where clause

sOrderBy - order by clause

Returns:

iterator of Assignment 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

getCodeTypeObjectId

public ObjectId getCodeTypeObjectId()
                             throws BusinessObjectException

Gets the unique ID of the parent assignment 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 assignment 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 assignment code of this assignment 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 assignment code of this assignment 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. 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

getCodeValue

public String getCodeValue()
                    throws BusinessObjectException

Gets the value of the assignment 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(String s)
                  throws BusinessObjectException

Sets the value of the assignment 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 String getDescription()
                      throws BusinessObjectException

Gets the description of the assignment code.

Returns:

the value in the field Description

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setDescription

public void setDescription(String s)
                    throws BusinessObjectException

Sets the description of the assignment code.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getCodeTypeName

public 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 Date getCreateDate()
                   throws BusinessObjectException

Gets the date this assignment code 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 assignment 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 String getCreateUser()
                     throws BusinessObjectException

Gets the name of the user that created this assignment code.

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

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

@Deprecated
public static String[] getDefaultXMLExportFields()

Deprecated.

Gets the fields that are exported by the hierarchical XML exporter when no fields are specified. This method is no longer relevant since the hierarchical XML exporter has been replaced by the flat XML exporter.

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 ResourceAssignmentCode object in the database.

Returns:

ObjectId the unique ID of the newly created ResourceAssignmentCode 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,
                                ResourceAssignmentCode[] resourceassignmentcodes)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException

Creates multiple ResourceAssignmentCode objects in the database.

Parameters:

session - the Session object

resourceassignmentcodes - array of ResourceAssignmentCode objects to create

Returns:

ObjectId[] the array of unique IDs of newly created ResourceAssignmentCode 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 ResourceAssignmentCode load(Session session,
                                          String[] fields,
                                          ObjectId objId)
                                   throws ServerException,
                                          NetworkException,
                                          BusinessObjectException

Loads a single ResourceAssignmentCode object from the database.

Parameters:

session - the Session object

fields - fields to load

objId - unique ID of the ResourceAssignmentCode object

Returns:

ResourceAssignmentCode the ResourceAssignmentCode 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<ResourceAssignmentCode> load(Session session,
                                                      String[] fields,
                                                      ObjectId[] objIds)
                                               throws ServerException,
                                                      NetworkException,
                                                      BusinessObjectException

Loads multiple ResourceAssignmentCode objects from the database.

Parameters:

session - the Session object

fields - fields to load

objIds - object ids of the ResourceAssignmentCode 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 ResourceAssignmentCode 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,
                          ResourceAssignmentCode[] resourceassignmentcodes)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException

Updates multiple ResourceAssignmentCode objects in the database.

Parameters:

session - the Session object

resourceassignmentcodes - array of ResourceAssignmentCode 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 ResourceAssignmentCode 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,
                          ResourceAssignmentCode[] resourceassignmentcodes)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException

Deletes multiple ResourceAssignmentCode objects from the database.

Parameters:

session - the Session object

resourceassignmentcodes - array of ResourceAssignmentCode 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