Primavera Integration API 7.0

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

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

public class ProjectCodeAssignment
extends BusinessObject

A project code assignment business object represents the assignment of a project code to a project. For each project code type, a project may have zero or one project codes assigned.

See Also:   Quick reference of ProjectCodeAssignment fields


Constructor Summary
ProjectCodeAssignment(Session session)
          Class constructor specifying the Session.
ProjectCodeAssignment(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
ProjectCodeAssignment(Session session, ObjectId projectObjectId, ObjectId projectCodeTypeObjectId)
          Class constructor specifying the Session and the individual components of the multi-part key: ProjectObjectId and ProjectCodeTypeObjectId.
ProjectCodeAssignment(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 ProjectCodeAssignment object in the database.
static ObjectId[] create(Session session, ProjectCodeAssignment[] projectcodeassignments)
          Creates multiple ProjectCodeAssignment objects in the database.
static ObjectId createObjectId(ObjectId projectObjectId, ObjectId projectCodeTypeObjectId)
          Creates a multi-part ObjectId from two individual ObjectIds.
 void delete()
          Deletes this ProjectCodeAssignment object from the database.
static void delete(Session session, ProjectCodeAssignment[] projectcodeassignments)
          Deletes multiple ProjectCodeAssignment objects from the database.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 java.util.Date getCreateDate()
          Gets the date this code assignment was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this code assignment.
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 getIsBaseline()
          Gets the boolean value indicating if this business object is related to a Project or Baseline.
 java.util.Date getLastUpdateDate()
          Gets the date this code assignment was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this code assignment.
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 ObjectId for this object.
 java.lang.String getProjectCodeDescription()
          Gets the description of the associated project code.
 ObjectId getProjectCodeObjectId()
          Gets the unique ID of the associated project code.
 java.lang.String getProjectCodeTypeName()
          Gets the name of the parent project code type.
 ObjectId getProjectCodeTypeObjectId()
          Gets the unique ID of the parent project code type.
 java.lang.String getProjectCodeValue()
          Gets the value of the associated project code.
 java.lang.String getProjectId()
          Gets the short code that uniquely identifies the associated project.
 java.lang.String getProjectName()
          Gets the name of the project to which the project code is assigned.
 ObjectId getProjectObjectId()
          Gets the unique ID of the project to which the project code is assigned.
static java.lang.String[] getRequiredCreateFields()
          Gets all fields that must be set before calling create() on this business object.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static ProjectCodeAssignment load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single ProjectCodeAssignment object from the database.
static BOIterator<ProjectCodeAssignment> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple ProjectCodeAssignment objects from the database.
 Project loadProject(java.lang.String[] fields)
          Loads an associated Project object from the database.
 ProjectCode loadProjectCode(java.lang.String[] fields)
          Loads an associated ProjectCode object from the database.
 ProjectCodeType loadProjectCodeType(java.lang.String[] fields)
          Loads an associated ProjectCodeType object from the database.
 void setProjectCodeObjectId(ObjectId o)
          Sets the unique ID of the associated project code.
 void setProjectObjectId(ObjectId o)
          Sets the unique ID of the project to which the project code is assigned.
 java.lang.String toString()
          Returns a string representation of the object.
 void update()
          Updates this ProjectCodeAssignment object in the database.
static void update(Session session, ProjectCodeAssignment[] projectcodeassignments)
          Updates multiple ProjectCodeAssignment objects in the database.
 
Methods inherited from class com.primavera.integration.client.bo.BusinessObject
equals, hashCode, isNull, setNull, setObjectId
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ProjectCodeAssignment

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

ProjectCodeAssignment

public ProjectCodeAssignment(Session session,
                             ObjectId objId)
                      throws BusinessObjectException
Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() is intended to be called on this object. For this particular object, the ObjectId is multi-part, created from the ProjectObjectId and ProjectCodeTypeObjectId field values. If you do not have the multi-part ObjectId already, it would be simpler to instead use the constructor that has multiple key parameters.

Parameters:
session - the Session
objId - the ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

ProjectCodeAssignment

public ProjectCodeAssignment(Session session,
                             ObjectId projectObjectId,
                             ObjectId projectCodeTypeObjectId)
                      throws BusinessObjectException
Class constructor specifying the Session and the individual components of the multi-part key: ProjectObjectId and ProjectCodeTypeObjectId. This constructor is most commonly used when update() is intended to be called on this object.

Parameters:
session - the Session
projectObjectId - the first ObjectId in the key
projectCodeTypeObjectId - the second ObjectId in the key
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

ProjectCodeAssignment

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

createObjectId

public static ObjectId createObjectId(ObjectId projectObjectId,
                                      ObjectId projectCodeTypeObjectId)
                               throws InvalidValueException
Creates a multi-part ObjectId from two individual ObjectIds.

Parameters:
projectObjectId - the ObjectId of the associated project object.
projectCodeTypeObjectId - the ObjectId of the associated projectCodeType object.
Returns:
ObjectId the multi-part ObjectId
Throws:
InvalidValueException - if one of the input parameters was invalid.
java.lang.IllegalArgumentException - if one of the input parameters was null.

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the ObjectId for this object. The ObjectId field serves as the primary key for the associated table in the database. For this object, the ObjectId is multi-part, consisting internally of the ProjectObjectId and ProjectCodeTypeObjectId fields.

Overrides:
getObjectId in class BusinessObject
Returns:
ObjectId the multi-part ObjectId of this object
Throws:
BusinessObjectException - if the ObjectId fields were not loaded.

create

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

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

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

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

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

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

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

loadProjectCodeType

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

Parameters:
fields - fields to load
Returns:
ProjectCodeType the ProjectCodeType object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadProjectCode

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

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

loadProject

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

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

getProjectObjectId

public ObjectId getProjectObjectId()
                            throws BusinessObjectException
Gets the unique ID of the project to which the project code is assigned. 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 ProjectObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setProjectObjectId

public void setProjectObjectId(ObjectId o)
                        throws BusinessObjectException
Sets the unique ID of the project to which the project code is assigned. 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

getProjectCodeTypeObjectId

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

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

getProjectCodeObjectId

public ObjectId getProjectCodeObjectId()
                                throws BusinessObjectException
Gets the unique ID of the associated project code. 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 ProjectCodeObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setProjectCodeObjectId

public void setProjectCodeObjectId(ObjectId o)
                            throws BusinessObjectException
Sets the unique ID of the associated project code. 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

getProjectCodeTypeName

public java.lang.String getProjectCodeTypeName()
                                        throws BusinessObjectException
Gets the name of the parent project code type.

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

getProjectCodeDescription

public java.lang.String getProjectCodeDescription()
                                           throws BusinessObjectException
Gets the description of the associated project code.

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

getProjectCodeValue

public java.lang.String getProjectCodeValue()
                                     throws BusinessObjectException
Gets the value of the associated project code.

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

getProjectName

public java.lang.String getProjectName()
                                throws BusinessObjectException
Gets the name of the project to which the project code is assigned.

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

getProjectId

public java.lang.String getProjectId()
                              throws BusinessObjectException
Gets the short code that uniquely identifies the associated project. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

getCreateDate

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

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

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

getIsBaseline

public boolean getIsBaseline()
                      throws BusinessObjectException
Gets the boolean value indicating if this business object is related to a Project or Baseline.

Returns:
the value in the field IsBaseline
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.