Primavera Integration API 7.0

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

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

public class ProjectCodeUser
extends BusinessObject

A project code user is a workflow recipient that is assigned to a project code value, allowing you to automatically route an initiated project or process to a reviewer. For each stage of the project or process initiation, the workflow requires one or more reviewers to be assigned, who can advance the initiation to the next stage. You can either select individual users to be reviewers, or use the project code routing feature. When you select a project code value, the user that is assigned to that value becomes the workflow recipient and so, the reviewer. Each project code value can have one licensed Primavera's Web application or Timesheets user assigned as a workflow recipient.

This is a read-only business object.

See Also:   Quick reference of ProjectCodeUser fields


Constructor Summary
ProjectCodeUser(Session session)
          Class constructor specifying the Session.
ProjectCodeUser(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
ProjectCodeUser(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)
          Class constructor called internally after objects are retrieved from the server.
 
Method Summary
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 ObjectId getCodeObjectId()
          Gets the unique ID of the project code.
 ObjectId getCodeTypeObjectId()
          Gets the unique ID of the parent project code type.
 java.lang.String getCodeValue()
          Gets the value of the project code.
 java.util.Date getCreateDate()
          Gets the date this ProjectCodeUser was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this ProjectCodeUser.
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.
 java.util.Date getLastUpdateDate()
          Gets the date this ProjectCodeUser was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this ProjectCodeUser.
static java.lang.String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 java.lang.String getUserName()
          Gets the user's login name.
 ObjectId getUserObjectId()
          Gets the unique ID of the user.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static ProjectCodeUser load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single ProjectCodeUser object from the database.
static BOIterator<ProjectCodeUser> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple ProjectCodeUser objects from the database.
 ProjectCode loadProjectCode(java.lang.String[] fields)
          Loads an associated ProjectCode object from the database.
 User loadUser(java.lang.String[] fields)
          Loads an associated User object from the database.
 java.lang.String toString()
          Returns a string representation of the object.
 
Methods inherited from class com.primavera.integration.client.bo.BusinessObject
equals, getObjectId, hashCode, isNull, setNull, setObjectId
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ProjectCodeUser

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

ProjectCodeUser

public ProjectCodeUser(Session session,
                       ObjectId objId)
                throws BusinessObjectException
Class constructor specifying the Session and ObjectId of the object.

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

ProjectCodeUser

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

load

public static ProjectCodeUser load(Session session,
                                   java.lang.String[] fields,
                                   ObjectId objId)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Loads a single ProjectCodeUser object from the database.

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

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

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

loadUser

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

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

getCodeObjectId

public ObjectId getCodeObjectId()
                         throws BusinessObjectException
Gets the unique ID of the 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 CodeObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCodeTypeObjectId

public ObjectId getCodeTypeObjectId()
                             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 CodeTypeObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUserObjectId

public ObjectId getUserObjectId()
                         throws BusinessObjectException
Gets the unique ID of the user. 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 UserObjectId
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 project code.

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

getUserName

public java.lang.String getUserName()
                             throws BusinessObjectException
Gets the user's login name.

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

getCreateDate

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

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

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

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.