Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

atg.epub.project
Interface Process

All Superinterfaces:
javax.ejb.EJBLocalObject
public interface Process
extends javax.ejb.EJBLocalObject

Class Process

Property Summaries

Property Name Property Type Property Description Flags
activity String Activity R, W, Cch, Qry
completionDate Timestamp Completion date R, W, Cch, Qry
creationDate Timestamp Creation date R, W, Cch, Qry
creator RepositoryItem Creator R, W, Cch, Qry
description String Description R, W, Cch, Qry
displayName String Name R, W, Cch, Qry
history List of History History R, W, CsD, CsU, Cch, CoM, Mv, Qry
id String Process id R, W, Cch, Id, Qry, Exp
previousProjectIds List Previous project ids R, W, Cch, CoM, Mv, Qry, Exp
project Project Current project R, W, Cch, Qry
siteId String Site Id R, W, Cch, Qry
status ProcessEnumStatus Status R, W, Cch, Qry
statusDetail String Status detail R, W, Cch, Qry
taskInfos Set of ProcessTaskInfo Task information R, W, CsD, CsU, Cch, CoM, Mv, Qry, Exp
version int Version R, Cch, Qry, Exp
workflow RepositoryItem Workflow R, Cch
workflowId String Workflow id R, W, Cch, Qry
workflowInstances Set Workflow instances R, W, CsD, CsU, Cch, CoM, Mv, Qry, Exp

Flags Key:R=readable, W=writable, CsD=cascadeDelete, CsI=cascadeInsert, CsU=cascadeUpdate, Cch=cacheable, CoM=collectionOrMap, Drv=derived, Id=idProperty, Mv=multivalued, Qry=queryable, Req=required, Exp=expert, Hdn=hidden, Prf=preferred

Property Details

Property activity ("Activity"): String

Property completionDate ("Completion date"): Timestamp

Property creationDate ("Creation date"): Timestamp

Property creator ("Creator"): RepositoryItem

Property description ("Description"): String

Property displayName ("Name"): String

Property history ("History"): List of History

Property id ("Process id"): String

Property previousProjectIds ("Previous project ids"): List

Property project ("Current project"): Project

Property siteId ("Site Id"): String

Property status ("Status"): ProcessEnumStatus

Property statusDetail ("Status detail"): String

Property taskInfos ("Task information"): Set of ProcessTaskInfo

Property version ("Version"): int

Property workflow ("Workflow"): RepositoryItem

Property workflowId ("Workflow id"): String

Property workflowInstances ("Workflow instances"): Set

Method Summary
 boolean _isMutable()
          Returns true if the item is mutable.
 History addHistory(java.lang.String pAction, java.lang.String pActionType, java.lang.String pDescription, java.util.Collection pParams)
          This is a convenience method for adding a new history item to a process' list of histories.
 void complete()
          This method will complete a process by setting its completionDate, and status flag to completed
 void copyTo(Process destination)
          Copies the property values of this instance to another instance of the same data type.
 void delete()
          This method will delete a process.
 java.lang.String getActivity()
          Getter for property activity ("Activity")
 java.sql.Timestamp getCompletionDate()
          Getter for property completionDate ("Completion date")
 java.sql.Timestamp getCreationDate()
          Getter for property creationDate ("Creation date")
 RepositoryItem getCreator()
          Getter for property creator ("Creator")
 java.lang.String getDescription()
          Getter for property description ("Description")
 java.lang.String getDisplayName()
          Getter for property displayName ("Name")
 boolean getHasVersion()
          Returns true if the value of property version is null.
 java.util.List getHistory()
          Getter for property history ("History")
 java.lang.String getId()
          Getter for property id ("Process id")
 Project getLastProject()
          Returns the project which was used in this process prior to the current one
 java.util.List getPreviousProjectIds()
          Getter for property previousProjectIds ("Previous project ids")
 RepositoryItem getProcessData()
          This method will get process data for a process in the right context.
 Project getProject()
          Getter for property project ("Current project")
 java.lang.String getSiteId()
          Getter for property siteId ("Site Id")
 ProcessEnumStatus getStatus()
          Getter for property status ("Status")
 java.lang.String getStatusDetail()
          Getter for property statusDetail ("Status detail")
 java.util.Set getTaskInfos()
          Getter for property taskInfos ("Task information")
 int getVersion()
          Getter for property version ("Version")
 RepositoryItem getWorkflow()
          Getter for property workflow ("Workflow")
 java.lang.String getWorkflowId()
          Getter for property workflowId ("Workflow id")
 java.util.Set getWorkflowInstances()
          Getter for property workflowInstances ("Workflow instances")
 boolean isRemoved()
          Returns true if the underlying object has been removed.
 void prepareInstanceForWrite()
          This must be called if the application intends to both read and write the instance in the same transaction, and it intends to do a read before doing a write.
 void setActivity(java.lang.String value)
          Setter for property activity ("Activity").
 void setCompletionDate(java.sql.Timestamp value)
          Setter for property completionDate ("Completion date").
 void setCreationDate(java.sql.Timestamp value)
          Setter for property creationDate ("Creation date").
 void setCreator(RepositoryItem value)
          Setter for property creator ("Creator").
 void setDescription(java.lang.String value)
          Setter for property description ("Description").
 void setDisplayName(java.lang.String value)
          Setter for property displayName ("Name").
 void setHistory(java.util.List value)
          Setter for property history ("History").
 void setId(java.lang.String value)
          Setter for property id ("Process id").
 void setPreviousProjectIds(java.util.List value)
          Setter for property previousProjectIds ("Previous project ids").
 void setProcessData(RepositoryItem pValue)
          This method will set process data for a process in the right context.
 void setProject(Project value)
          Setter for property project ("Current project").
 void setSiteId(java.lang.String value)
          Setter for property siteId ("Site Id").
 void setStatus(ProcessEnumStatus value)
          Setter for property status ("Status").
 void setStatusDetail(java.lang.String value)
          Setter for property statusDetail ("Status detail").
 void setTaskInfos(java.util.Set value)
          Setter for property taskInfos ("Task information").
 void setWorkflowId(java.lang.String value)
          Setter for property workflowId ("Workflow id").
 void setWorkflowInstances(java.util.Set value)
          Setter for property workflowInstances ("Workflow instances").
 void writeInstance()
          This must be called after modifying an instance with a persistent implementation to guarantee that all changes are made persistent and visible to queries.
 
Methods inherited from interface javax.ejb.EJBLocalObject
getEJBLocalHome, getPrimaryKey, isIdentical, remove
 

Method Detail

getActivity

java.lang.String getActivity()
                             throws javax.ejb.EJBException
Getter for property activity ("Activity")

Returns:
String
Throws:
javax.ejb.EJBException

setActivity

void setActivity(java.lang.String value)
                 throws javax.ejb.EJBException
Setter for property activity ("Activity"). The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:
value - String
Throws:
javax.ejb.EJBException

getCompletionDate

java.sql.Timestamp getCompletionDate()
                                     throws javax.ejb.EJBException
Getter for property completionDate ("Completion date")

Returns:
Timestamp
Throws:
javax.ejb.EJBException

setCompletionDate

void setCompletionDate(java.sql.Timestamp value)
                       throws javax.ejb.EJBException
Setter for property completionDate ("Completion date"). The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:
value - Timestamp
Throws:
javax.ejb.EJBException

getCreationDate

java.sql.Timestamp getCreationDate()
                                   throws javax.ejb.EJBException
Getter for property creationDate ("Creation date")

Returns:
Timestamp
Throws:
javax.ejb.EJBException

setCreationDate

void setCreationDate(java.sql.Timestamp value)
                     throws javax.ejb.EJBException
Setter for property creationDate ("Creation date"). The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:
value - Timestamp
Throws:
javax.ejb.EJBException

getCreator

RepositoryItem getCreator()
                          throws javax.ejb.EJBException
Getter for property creator ("Creator")

Returns:
RepositoryItem
Throws:
javax.ejb.EJBException

setCreator

void setCreator(RepositoryItem value)
                throws javax.ejb.EJBException
Setter for property creator ("Creator"). The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:
value - RepositoryItem
Throws:
javax.ejb.EJBException

getDescription

java.lang.String getDescription()
                                throws javax.ejb.EJBException
Getter for property description ("Description")

Returns:
String
Throws:
javax.ejb.EJBException

setDescription

void setDescription(java.lang.String value)
                    throws javax.ejb.EJBException
Setter for property description ("Description"). The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:
value - String
Throws:
javax.ejb.EJBException

getDisplayName

java.lang.String getDisplayName()
                                throws javax.ejb.EJBException
Getter for property displayName ("Name")

Returns:
String
Throws:
javax.ejb.EJBException

setDisplayName

void setDisplayName(java.lang.String value)
                    throws javax.ejb.EJBException
Setter for property displayName ("Name"). The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:
value - String
Throws:
javax.ejb.EJBException

getHistory

java.util.List getHistory()
                          throws javax.ejb.EJBException
Getter for property history ("History")

Returns:
List of History
Throws:
javax.ejb.EJBException

setHistory

void setHistory(java.util.List value)
                throws javax.ejb.EJBException
Setter for property history ("History"). The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:
value - List of History
Throws:
javax.ejb.EJBException

getId

java.lang.String getId()
                       throws javax.ejb.EJBException
Getter for property id ("Process id")

Returns:
String
Throws:
javax.ejb.EJBException

setId

void setId(java.lang.String value)
           throws javax.ejb.EJBException
Setter for property id ("Process id"). The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:
value - String
Throws:
javax.ejb.EJBException

getPreviousProjectIds

java.util.List getPreviousProjectIds()
                                     throws javax.ejb.EJBException
Getter for property previousProjectIds ("Previous project ids")

Returns:
List
Throws:
javax.ejb.EJBException

setPreviousProjectIds

void setPreviousProjectIds(java.util.List value)
                           throws javax.ejb.EJBException
Setter for property previousProjectIds ("Previous project ids"). The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:
value - List
Throws:
javax.ejb.EJBException

getProject

Project getProject()
                   throws javax.ejb.EJBException
Getter for property project ("Current project")

Returns:
Project
Throws:
javax.ejb.EJBException

setProject

void setProject(Project value)
                throws javax.ejb.EJBException
Setter for property project ("Current project"). The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:
value - Project
Throws:
javax.ejb.EJBException

getSiteId

java.lang.String getSiteId()
                           throws javax.ejb.EJBException
Getter for property siteId ("Site Id")

Returns:
String
Throws:
javax.ejb.EJBException

setSiteId

void setSiteId(java.lang.String value)
               throws javax.ejb.EJBException
Setter for property siteId ("Site Id"). The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:
value - String
Throws:
javax.ejb.EJBException

getStatus

ProcessEnumStatus getStatus()
                            throws javax.ejb.EJBException
Getter for property status ("Status")

Returns:
ProcessEnumStatus
Throws:
javax.ejb.EJBException

setStatus

void setStatus(ProcessEnumStatus value)
               throws javax.ejb.EJBException
Setter for property status ("Status"). The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:
value - ProcessEnumStatus
Throws:
javax.ejb.EJBException

getStatusDetail

java.lang.String getStatusDetail()
                                 throws javax.ejb.EJBException
Getter for property statusDetail ("Status detail")

Returns:
String
Throws:
javax.ejb.EJBException

setStatusDetail

void setStatusDetail(java.lang.String value)
                     throws javax.ejb.EJBException
Setter for property statusDetail ("Status detail"). The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:
value - String
Throws:
javax.ejb.EJBException

getTaskInfos

java.util.Set getTaskInfos()
                           throws javax.ejb.EJBException
Getter for property taskInfos ("Task information")

Returns:
Set of ProcessTaskInfo
Throws:
javax.ejb.EJBException

setTaskInfos

void setTaskInfos(java.util.Set value)
                  throws javax.ejb.EJBException
Setter for property taskInfos ("Task information"). The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:
value - Set of ProcessTaskInfo
Throws:
javax.ejb.EJBException

getVersion

int getVersion()
               throws javax.ejb.EJBException
Getter for property version ("Version")

Returns:
int
Throws:
javax.ejb.EJBException

getHasVersion

boolean getHasVersion()
                      throws javax.ejb.EJBException
Returns true if the value of property version is null.

Throws:
javax.ejb.EJBException

getWorkflow

RepositoryItem getWorkflow()
                           throws javax.ejb.EJBException
Getter for property workflow ("Workflow")

Returns:
RepositoryItem
Throws:
javax.ejb.EJBException

getWorkflowId

java.lang.String getWorkflowId()
                               throws javax.ejb.EJBException
Getter for property workflowId ("Workflow id")

Returns:
String
Throws:
javax.ejb.EJBException

setWorkflowId

void setWorkflowId(java.lang.String value)
                   throws javax.ejb.EJBException
Setter for property workflowId ("Workflow id"). The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:
value - String
Throws:
javax.ejb.EJBException

getWorkflowInstances

java.util.Set getWorkflowInstances()
                                   throws javax.ejb.EJBException
Getter for property workflowInstances ("Workflow instances")

Returns:
Set
Throws:
javax.ejb.EJBException

setWorkflowInstances

void setWorkflowInstances(java.util.Set value)
                          throws javax.ejb.EJBException
Setter for property workflowInstances ("Workflow instances"). The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:
value - Set
Throws:
javax.ejb.EJBException

isRemoved

boolean isRemoved()
                  throws javax.ejb.EJBException
Returns true if the underlying object has been removed. False otherwise.

Throws:
javax.ejb.EJBException

copyTo

void copyTo(Process destination)
            throws javax.ejb.EJBException
Copies the property values of this instance to another instance of the same data type. Only properties that are both readable and writable are copied. Each property is copied by calling the getter method on the source instance and setting the result in the destination instance using the setter method.

Throws:
javax.ejb.EJBException

writeInstance

void writeInstance()
                   throws javax.ejb.EJBException
This must be called after modifying an instance with a persistent implementation to guarantee that all changes are made persistent and visible to queries. Changes might be made visible before calling this method, but this is not guaranteed until this method is called.

Throws:
javax.ejb.EJBException

prepareInstanceForWrite

void prepareInstanceForWrite()
                             throws javax.ejb.EJBException
This must be called if the application intends to both read and write the instance in the same transaction, and it intends to do a read before doing a write. This must be called before that first read.

Throws:
javax.ejb.EJBException

_isMutable

boolean _isMutable()
Returns true if the item is mutable. Items are only mutable after a setter method or prepareInstanceForWrite is called.

addHistory

History addHistory(java.lang.String pAction,
                   java.lang.String pActionType,
                   java.lang.String pDescription,
                   java.util.Collection pParams)
                   throws javax.ejb.CreateException,
                          TransactionDemarcationException,
                          javax.ejb.EJBException
This is a convenience method for adding a new history item to a process' list of histories. Note that the History which is returned has already been added to the process. It is returned only for convenience.

Parameters:
pAction - The action name for the history element
pActionType - The type of action of the history element
pDescription - Descriptive text for the history element
pParams - parameter for the history message eg. if revoking a projects from a target this could be the target ID.
Returns:
The History object which was created
Throws:
javax.ejb.CreateException - If an exception occurred while creating the history element
TransactionDemarcationException - If a transaction error occurs
javax.ejb.EJBException - A system-level error occurred

complete

void complete()
              throws TransactionDemarcationException,
                     javax.ejb.EJBException
This method will complete a process by setting its completionDate, and status flag to completed

Throws:
TransactionDemarcationException - If a transaction error occurs
javax.ejb.EJBException - A system-level error occurred

delete

void delete()
            throws atg.epub.project.InvalidStateException,
                   javax.ejb.RemoveException,
                   TransactionDemarcationException,
                   javax.ejb.EJBException
This method will delete a process. If the process has an active project, then a RemoveException is thrown

Throws:
atg.epub.project.InvalidStateException - If the process is in a state where is cannot be deleted
javax.ejb.RemoveException - If the process could not be deleted
TransactionDemarcationException - If a transaction error occurs
javax.ejb.EJBException - A system-level error occurred

getLastProject

Project getLastProject()
                       throws javax.ejb.FinderException,
                              javax.ejb.EJBException
Returns the project which was used in this process prior to the current one

Returns:
The previous project used by this process
Throws:
javax.ejb.FinderException - If the previous project could not be found
javax.ejb.EJBException - A system-level error occurred

getProcessData

RepositoryItem getProcessData()
                              throws javax.ejb.EJBException
This method will get process data for a process in the right context. Process lives in a non versioned repository while processData lives in a versioned repository. Correct context is required for the version repository to resolve processData property. This method ensure's that process's project's workspace is set in context when retrieving processData

Throws:
javax.ejb.EJBException - when there are technical errors.

setProcessData

void setProcessData(RepositoryItem pValue)
                    throws javax.ejb.EJBException
This method will set process data for a process in the right context. Process lives in a non versioned repository while processData lives in a versioned repository. Correct context is required for the version repository to resolve processData property. This method ensure's that process's project's workspace is set in context when retrieving processData

Parameters:
pValue - The property value to set
Throws:
javax.ejb.EJBException - when there are technical errors.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD