|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.ProjectCodeAssignment
public class ProjectCodeAssignment
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 |
---|
public ProjectCodeAssignment(Session session)
session
- the Sessionpublic ProjectCodeAssignment(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ProjectCodeAssignment(Session session, ObjectId projectObjectId, ObjectId projectCodeTypeObjectId) throws BusinessObjectException
session
- the SessionprojectObjectId
- the first ObjectId in the keyprojectCodeTypeObjectId
- the second ObjectId in the key
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ProjectCodeAssignment(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
session
- the SessionrowSet
- the PrmRowSet retrieved from the serveriIndex
- the row index in the PrmRowSet associated with this business object
BusinessObjectException
- if a problem occurred in the client-side business objectsMethod Detail |
---|
public static ObjectId createObjectId(ObjectId projectObjectId, ObjectId projectCodeTypeObjectId) throws InvalidValueException
projectObjectId
- the ObjectId of the associated project object.projectCodeTypeObjectId
- the ObjectId of the associated projectCodeType object.
InvalidValueException
- if one of the input parameters was invalid.
java.lang.IllegalArgumentException
- if one of the input parameters was null.public ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if the ObjectId fields were not loaded.public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static ObjectId[] create(Session session, ProjectCodeAssignment[] projectcodeassignments) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectcodeassignments
- array of ProjectCodeAssignment objects to create
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static ProjectCodeAssignment load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ProjectCodeAssignment object
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static BOIterator<ProjectCodeAssignment> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ProjectCodeAssignment objects
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void update() throws ServerException, NetworkException, BusinessObjectException
update
in class BOBase
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static void update(Session session, ProjectCodeAssignment[] projectcodeassignments) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectcodeassignments
- array of ProjectCodeAssignment objects to update
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void delete() throws ServerException, NetworkException, BusinessObjectException
delete
in class BOBase
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static void delete(Session session, ProjectCodeAssignment[] projectcodeassignments) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectcodeassignments
- array of ProjectCodeAssignment objects to delete
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ProjectCodeType loadProjectCodeType(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ProjectCode loadProjectCode(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Project loadProject(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getProjectObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setProjectObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getProjectCodeTypeObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getProjectCodeObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setProjectCodeObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getProjectCodeTypeName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getProjectCodeDescription() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getProjectCodeValue() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getProjectName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getProjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getCreateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getLastUpdateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getCreateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getLastUpdateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsBaseline() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static java.lang.String[] getRequiredCreateFields()
public static java.lang.String[] getFilterableFields()
public static java.lang.String[] getInternalDefaultLoadFields()
public static java.lang.String[] getAllFields()
public static java.lang.String[] getInternalAllFields()
public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
public static java.lang.String[] getWritableFields()
public static java.lang.String[] getDefaultXMLExportFields()
public static java.lang.String[] getMinimumXMLExportFields()
public java.lang.String toString()
toString
in class java.lang.Object
|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |