|
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.base.InitiationBase
com.primavera.integration.client.bo.object.Initiation
public class Initiation
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 |
---|
public Initiation(Session session)
session
- the Sessionpublic Initiation(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Initiation(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 Initiation load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the Initiation 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<Initiation> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the Initiation 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 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 User loadUser(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 com.primavera.integration.collab.initiation.InitiationStage[] loadAllStages() throws ServerException, BusinessObjectException, java.rmi.RemoteException
loadAllStages
in class com.primavera.integration.client.bo.base.InitiationBase
ServerException
BusinessObjectException
java.rmi.RemoteException
public com.primavera.integration.collab.initiation.InitiationStage[] loadStages(int[] stages) throws ServerException, BusinessObjectException, java.rmi.RemoteException
loadStages
in class com.primavera.integration.client.bo.base.InitiationBase
stages
- the numeric value of stages to load
ServerException
BusinessObjectException
java.rmi.RemoteException
public ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
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 java.lang.String getInitiatorName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getInitiatorObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getCurrentStageName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getStageModifiedFlag() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getInitiatedDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getWorkflowTemplateId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getCurrentStageNumber() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic InitiationStatus getStatus() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getProcessFlag() 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[] 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 |