Primavera Integration API 7.0

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

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.base.InitiationBase
              extended by com.primavera.integration.client.bo.object.Initiation

public class Initiation
extends com.primavera.integration.client.bo.base.InitiationBase

Primavera Project Workflow features automate the process of launching, organizing, analyzing, and approving requests for new work: either new projects (project initiation) or changes to existing projects (process initiation). In both cases, the project goes through stages determined by the associated template. That associated template defines the data, routing, and approval requirements that will be used for each stage of the workflow. Access to the initiation process is determined by the user's security settings. The Initiation object provides read-only access to the initiation data, such as the initiation type (project or process), current initiation status, the initiator, the current stage in the initiation, etc.

See Also:   Quick reference of Initiation fields


Constructor Summary
Initiation(Session session)
          Class constructor specifying the Session.
Initiation(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
Initiation(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.
 java.util.Date getCreateDate()
          Gets the date this Initation was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this Initation.
 java.lang.String getCurrentStageName()
          Gets the name of the stage in the initiation process where the project is currently in.
 int getCurrentStageNumber()
          Gets the number of the stage in the initiation process where the project is currently in.
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.
 java.util.Date getInitiatedDate()
          Gets the date when this project was initiated.
 java.lang.String getInitiatorName()
          Gets the name of the user who initiated the project or process request.
 ObjectId getInitiatorObjectId()
          Gets the unique ID of the user who initiated the project or process request.
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 Initation was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this Initation.
static java.lang.String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 java.lang.String getName()
          Gets the name of the initiated project.
 ObjectId getObjectId()
          Gets the unique ID generated by the system.
 boolean getProcessFlag()
          Gets the flag indicating whether this object represents an initiated process or an initated project.
 ObjectId getProjectObjectId()
          Gets the unique ID of the initiated project.
 boolean getStageModifiedFlag()
          Gets the boolean value that determines whether any information has been changed at the current stage.
 InitiationStatus getStatus()
          Gets the status of the project in the current stage of initiation: 'Initiated', 'Submitted', 'InReview', 'Approved', or 'Rejected'.
 java.lang.String getWorkflowTemplateId()
          Gets the unique ID of the template used in the initiation process.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static Initiation load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single Initiation object from the database.
static BOIterator<Initiation> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple Initiation objects from the database.
 com.primavera.integration.collab.initiation.InitiationStage[] loadAllStages()
          Gets the stage data for this object.
 Project loadProject(java.lang.String[] fields)
          Loads an associated Project object from the database.
 com.primavera.integration.collab.initiation.InitiationStage[] loadStages(int[] stages)
          Gets the stage data for this object.
 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, hashCode, isNull, setNull, setObjectId
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Initiation

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

Initiation

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

Initiation

public Initiation(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 Initiation load(Session session,
                              java.lang.String[] fields,
                              ObjectId objId)
                       throws ServerException,
                              NetworkException,
                              BusinessObjectException
Loads a single Initiation object from the database.

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

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

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

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

loadAllStages

public com.primavera.integration.collab.initiation.InitiationStage[] loadAllStages()
                                                                            throws ServerException,
                                                                                   BusinessObjectException,
                                                                                   java.rmi.RemoteException
Gets the stage data for this object.

Overrides:
loadAllStages in class com.primavera.integration.client.bo.base.InitiationBase
Returns:
com.primavera.integration.collab.initiation.InitiationStage[] stages and reviewer data for this object
Throws:
ServerException
BusinessObjectException
java.rmi.RemoteException

loadStages

public com.primavera.integration.collab.initiation.InitiationStage[] loadStages(int[] stages)
                                                                         throws ServerException,
                                                                                BusinessObjectException,
                                                                                java.rmi.RemoteException
Gets the stage data for this object.

Overrides:
loadStages in class com.primavera.integration.client.bo.base.InitiationBase
Parameters:
stages - the numeric value of stages to load
Returns:
com.primavera.integration.collab.initiation.InitiationStage[] stages and reviewer data for the specified stages
Throws:
ServerException
BusinessObjectException
java.rmi.RemoteException

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the unique ID generated by the system.

Overrides:
getObjectId in class BusinessObject
Returns:
the value in the field ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getProjectObjectId

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

getInitiatorName

public java.lang.String getInitiatorName()
                                  throws BusinessObjectException
Gets the name of the user who initiated the project or process request. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getInitiatorObjectId

public ObjectId getInitiatorObjectId()
                              throws BusinessObjectException
Gets the unique ID of the user who initiated the project or process request. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

getCurrentStageName

public java.lang.String getCurrentStageName()
                                     throws BusinessObjectException
Gets the name of the stage in the initiation process where the project is currently in.

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

getStageModifiedFlag

public boolean getStageModifiedFlag()
                             throws BusinessObjectException
Gets the boolean value that determines whether any information has been changed at the current stage.

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

getInitiatedDate

public java.util.Date getInitiatedDate()
                                throws BusinessObjectException
Gets the date when this project was initiated.

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

getName

public java.lang.String getName()
                         throws BusinessObjectException
Gets the name of the initiated project.

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

getWorkflowTemplateId

public java.lang.String getWorkflowTemplateId()
                                       throws BusinessObjectException
Gets the unique ID of the template used in the initiation process.

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

getCurrentStageNumber

public int getCurrentStageNumber()
                          throws BusinessObjectException
Gets the number of the stage in the initiation process where the project is currently in.

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

getStatus

public InitiationStatus getStatus()
                           throws BusinessObjectException
Gets the status of the project in the current stage of initiation: 'Initiated', 'Submitted', 'InReview', 'Approved', or 'Rejected'.

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

getProcessFlag

public boolean getProcessFlag()
                       throws BusinessObjectException
Gets the flag indicating whether this object represents an initiated process or an initated project.

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

getCreateDate

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

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

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

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.