atg.epub.project

Interface ProcessHome

All Superinterfaces:

javax.ejb.EJBLocalHome

public interface ProcessHome
extends javax.ejb.EJBLocalHome

Finder Summaries

Finder Name	Finder Description	Returns
findByPrimaryKey		one
findAllProcesses	Returns all the processes in the system	many
findByDisplayName	Returns the process(es) with the given name	many
findById	Returns the process with the given id	one
countOfAllCompletedProcesses	Returns the count of the completed processes in the system	count
countOfAllProcesses	Returns the count of processes in the system	count
countOfProcessesByStatus	Returns the count of processes with the given status	count
findProcessByPreviousProjectId	Return the process whose previousProjectId collection contains pProjectId	one
findProcessByProjectId	Return the process whose projectId is specified in pProjectId	one
findProcessesByStatus	Returns the processes which match the given status	many
findProcessesByStatusAndActivity	Returns the processes which match the given status and activity	many
findProcessesByStatusAndActivityForRangge	Returns a range of processes which match the given status and activity	many
findProcessesByStatusSort	Returns the processes which match the given status, sorted by the properties in the pSortProperties argument	many

Method Summary

Methods

Modifier and Type	Method and Description
int	countOfAllCompletedProcesses() Returns the count of the completed processes in the system
int	countOfAllProcesses() Returns the count of processes in the system
int	countOfProcessesByStatus(java.lang.String pStatus) Returns the count of processes with the given status
Process	create() Returns a new instance.
Process	create(java.lang.String pId) Returns a new instance with the repository id set to the given id.
Process	createProcess(java.lang.String pProcessName, java.lang.String pWorkflowName) Creates a new persistent process by supplying a processName and workflowName
Process	createProcessForImport(java.lang.String pProcessName, java.lang.String pWorkflowName) Used by import tools for specialized process creation
Process	createProcessForImport(java.lang.String pProcessName, java.lang.String pWorkflowName, boolean pAutoDeploy) Deprecated. use createProcessForImport(String pProcessName, String pWorkflowName) instead
Process	createProcessForImport(java.lang.String pProcessName, java.lang.String pWorkflowName, java.lang.String pActivityId) Used by import tools for specialized process creation
void	deployProcessForImport(java.lang.String pWorkspaceId, java.lang.String pUsername, java.lang.String pComment, java.lang.String[] pTargets) Used by import tools for process deployment
java.util.Collection	findAllProcesses(int pStartIndex, int pCount) Returns all the processes in the system
java.util.Collection	findByDisplayName(java.lang.String pDisplayName) Returns the process(es) with the given name
Process	findById(java.lang.String pId) Returns the process with the given id
Process	findByPrimaryKey(java.lang.String primaryKey) Returns the instance with the given primary key, throws ObjectNotFoundException if the instance is not found.
Process	findProcessByPreviousProjectId(java.lang.String pProjectId) Return the process whose previousProjectId collection contains pProjectId
Process	findProcessByProjectId(java.lang.String pProjectId) Return the process whose projectId is specified in pProjectId
java.util.Collection	findProcessesByStatus(java.lang.String pStatus, int pStartIndex, int pCount) Returns the processes which match the given status
java.util.Collection	findProcessesByStatusAndActivity(java.lang.String pStatus, java.lang.String pActivity) Returns the processes which match the given status and activity
java.util.Collection	findProcessesByStatusAndActivityForRangge(java.lang.String pStatus, java.lang.String pActivity, int pStartIndex, int pCount) Returns a range of processes which match the given status and activity
java.util.Collection	findProcessesByStatusSort(java.lang.String pStatus, int pStartIndex, int pCount, java.lang.String pSortProperties) Returns the processes which match the given status, sorted by the properties in the pSortProperties argument
Process	initializeProcess(Process pBeanProcess, java.lang.String pWorkflowName) This method creates a process.
Process	initializeProcess(Process pBeanProcess, java.lang.String pWorkflowName, java.lang.String pSegmentName) This method creates a process.
Process	initializeProcessWithGlobalWorkflow(Process pBeanProcess, java.lang.String pWorkflowName) Same as initializeProcess() except that it does not require a valid session to be bound to create the process
Process	wrapRepositoryItem(RepositoryItem pRepositoryItem)
java.util.Collection	wrapRepositoryItems(java.util.Collection pRepositoryItems)

Methods inherited from interface javax.ejb.EJBLocalHome

remove

Method Detail

create

Process create()
               throws javax.ejb.CreateException,
                      javax.ejb.EJBException

Returns a new instance. The properties are set to default values, and may be changed by using the appropriate setter methods. The instance may be a repository or bean implementation depending on how this home's EPubHomes factory was obtained. If the instance is backed by a persistent implementation, it may not actually be persisted until Process.writeInstance() is called on the instance (and the transaction is committed, if the implementation is transaction-aware).

Throws:

javax.ejb.CreateException

javax.ejb.EJBException

create

Process create(java.lang.String pId)
               throws javax.ejb.CreateException,
                      javax.ejb.EJBException

Returns a new instance with the repository id set to the given id. The properties are set to default values, and may be changed by using the appropriate setter methods. The instance may be a repository or bean implementation depending on how this home's EPubHomes factory was obtained. If the instance is backed by a persistent implementation, it may not actually be persisted until Process.writeInstance() is called on the instance (and the transaction is committed, if the implementation is transaction-aware).

Throws:

javax.ejb.CreateException

javax.ejb.EJBException

findByPrimaryKey

Process findByPrimaryKey(java.lang.String primaryKey)
                         throws javax.ejb.FinderException,
                                javax.ejb.EJBException

Returns the instance with the given primary key, throws ObjectNotFoundException if the instance is not found.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findAllProcesses

java.util.Collection findAllProcesses(int pStartIndex,
                                    int pCount)
                                      throws javax.ejb.FinderException,
                                             javax.ejb.EJBException

Returns all the processes in the system

Parameters:

pStartIndex - The starting index within the result set to return the items from

pCount - The number of items within the result set to return starting at pStartIndex

Returns:

a Collection of Process instances matching the criteria. The Collection.iterator() method can be used to retrieve the instances in order. If no instances match the criteria, then an empty Collection is returned. A null value is never returned.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findByDisplayName

java.util.Collection findByDisplayName(java.lang.String pDisplayName)
                                       throws javax.ejb.FinderException,
                                              javax.ejb.EJBException

Returns the process(es) with the given name

Parameters:

pDisplayName - The displayName of the process(es) to return

Returns:

a Collection of Process instances matching the criteria. The Collection.iterator() method can be used to retrieve the instances in order. If no instances match the criteria, then an empty Collection is returned. A null value is never returned.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findById

Process findById(java.lang.String pId)
                 throws javax.ejb.FinderException,
                        javax.ejb.EJBException

Returns the process with the given id

Parameters:

pId - The id of the process to return

Returns:

an instance matching the query criteria, or throws ObjectNotFoundException if no such instance is found.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

countOfAllCompletedProcesses

int countOfAllCompletedProcesses()
                                 throws javax.ejb.FinderException,
                                        javax.ejb.EJBException

Returns the count of the completed processes in the system

Returns:

the number of instances matching the query criteria.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

countOfAllProcesses

int countOfAllProcesses()
                        throws javax.ejb.FinderException,
                               javax.ejb.EJBException

Returns the count of processes in the system

Returns:

the number of instances matching the query criteria.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

countOfProcessesByStatus

int countOfProcessesByStatus(java.lang.String pStatus)
                             throws javax.ejb.FinderException,
                                    javax.ejb.EJBException

Returns the count of processes with the given status

Parameters:

pStatus - The status of the processes which should be counted

Returns:

the number of instances matching the query criteria.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findProcessByPreviousProjectId

Process findProcessByPreviousProjectId(java.lang.String pProjectId)
                                       throws javax.ejb.FinderException,
                                              javax.ejb.EJBException

Return the process whose previousProjectId collection contains pProjectId

Parameters:

pProjectId - The previous project id to return the process for

Returns:

an instance matching the query criteria, or throws ObjectNotFoundException if no such instance is found.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findProcessByProjectId

Process findProcessByProjectId(java.lang.String pProjectId)
                               throws javax.ejb.FinderException,
                                      javax.ejb.EJBException

Return the process whose projectId is specified in pProjectId

Parameters:

pProjectId - The project id to return the process for

Returns:

an instance matching the query criteria, or throws ObjectNotFoundException if no such instance is found.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findProcessesByStatus

java.util.Collection findProcessesByStatus(java.lang.String pStatus,
                                         int pStartIndex,
                                         int pCount)
                                           throws javax.ejb.FinderException,
                                                  javax.ejb.EJBException

Returns the processes which match the given status

Parameters:

pStatus - The status of the processes which should be returned

pStartIndex - The starting index within the result set to return the items from

pCount - The number of items within the result set to return starting at pStartIndex

Returns:

a Collection of Process instances matching the criteria. The Collection.iterator() method can be used to retrieve the instances in order. If no instances match the criteria, then an empty Collection is returned. A null value is never returned.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findProcessesByStatusAndActivity

java.util.Collection findProcessesByStatusAndActivity(java.lang.String pStatus,
                                                    java.lang.String pActivity)
                                                      throws javax.ejb.FinderException,
                                                             javax.ejb.EJBException

Returns the processes which match the given status and activity

Parameters:

pStatus - The status of the processes which should be returned

pActivity - The type of activity for this processes (i.e. the workflow) which should be returned

Returns:

a Collection of Process instances matching the criteria. The Collection.iterator() method can be used to retrieve the instances in order. If no instances match the criteria, then an empty Collection is returned. A null value is never returned.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findProcessesByStatusAndActivityForRangge

java.util.Collection findProcessesByStatusAndActivityForRangge(java.lang.String pStatus,
                                                             java.lang.String pActivity,
                                                             int pStartIndex,
                                                             int pCount)
                                                               throws javax.ejb.FinderException,
                                                                      javax.ejb.EJBException

Returns a range of processes which match the given status and activity

Parameters:

pStatus - The status of the processes which should be returned

pActivity - The type of activity for this processes (i.e. the workflow) which should be returned

pStartIndex - The starting index within the result set to return the items from

pCount - The number of items within the result set to return starting at pStartIndex

Returns:

a Collection of Process instances matching the criteria. The Collection.iterator() method can be used to retrieve the instances in order. If no instances match the criteria, then an empty Collection is returned. A null value is never returned.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findProcessesByStatusSort

java.util.Collection findProcessesByStatusSort(java.lang.String pStatus,
                                             int pStartIndex,
                                             int pCount,
                                             java.lang.String pSortProperties)
                                               throws javax.ejb.FinderException,
                                                      javax.ejb.EJBException

Returns the processes which match the given status, sorted by the properties in the pSortProperties argument

Parameters:

pStatus - The status of the processes which should be returned

pStartIndex - The starting index within the result set to return the items from

pCount - The number of items within the result set to return starting at pStartIndex

pSortProperties - The properties to sort the results by. Separate multiple properties with a comma (,).

Returns:

a Collection of Process instances matching the criteria. The Collection.iterator() method can be used to retrieve the instances in order. If no instances match the criteria, then an empty Collection is returned. A null value is never returned.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

wrapRepositoryItems

java.util.Collection wrapRepositoryItems(java.util.Collection pRepositoryItems)

wrapRepositoryItem

Process wrapRepositoryItem(RepositoryItem pRepositoryItem)

createProcess

Process createProcess(java.lang.String pProcessName,
                    java.lang.String pWorkflowName)
                      throws ActionException,
                             WorkflowException,
                             javax.ejb.CreateException,
                             TransactionDemarcationException,
                             javax.ejb.EJBException

Creates a new persistent process by supplying a processName and workflowName

Parameters:

pProcessName - The name for the new process

pWorkflowName - The name of the workflow to be used by this process

Returns:

The created process

Throws:

ActionException - If an error occurs in the workflow when the process is created

WorkflowException - If a workflow error occurs while creating the process

javax.ejb.CreateException - If the process could not be created

TransactionDemarcationException - If a transaction error occurs

javax.ejb.EJBException - A system-level error occurred

createProcessForImport

Process createProcessForImport(java.lang.String pProcessName,
                             java.lang.String pWorkflowName)
                               throws ActionException,
                                      WorkflowException,
                                      javax.ejb.CreateException,
                                      TransactionDemarcationException,
                                      javax.ejb.EJBException

Used by import tools for specialized process creation

Parameters:

pProcessName - The name of the process to create

pWorkflowName - The name of the workflow to use for the created process

Returns:

The created process

Throws:

ActionException - if an error occurs in the workflow when the process is created

WorkflowException - if a workflow error occurs while creating the process

javax.ejb.CreateException - if the process could not be created

TransactionDemarcationException - if a transaction error occurs

javax.ejb.EJBException - A system-level error occurred

createProcessForImport

Process createProcessForImport(java.lang.String pProcessName,
                             java.lang.String pWorkflowName,
                             java.lang.String pActivityId)
                               throws ActionException,
                                      WorkflowException,
                                      javax.ejb.CreateException,
                                      TransactionDemarcationException,
                                      javax.ejb.EJBException

Used by import tools for specialized process creation

Parameters:

pProcessName - The name of the process to create

pWorkflowName - The name of the workflow to use for the created process

pActivityId - The ID of the activity to use for the created process

Returns:

The created process

Throws:

ActionException - if an error occurs in the workflow when the process is created

WorkflowException - if a workflow error occurs while creating the process

javax.ejb.CreateException - if the process could not be created

TransactionDemarcationException - if a transaction error occurs

javax.ejb.EJBException - A system-level error occurred

createProcessForImport

Process createProcessForImport(java.lang.String pProcessName,
                             java.lang.String pWorkflowName,
                             boolean pAutoDeploy)
                               throws ActionException,
                                      WorkflowException,
                                      javax.ejb.CreateException,
                                      TransactionDemarcationException,
                                      javax.ejb.EJBException

Deprecated. use createProcessForImport(String pProcessName, String pWorkflowName) instead

Used by import tools for specialized process creation

Parameters:

pProcessName - The name of the process to create

pWorkflowName - The name of the workflow to use for the created process

pAutoDeploy - Determines whether or not the process assets should be deployed after the import

Returns:

The created process

Throws:

ActionException - if an error occurs in the workflow when the process is created

WorkflowException - if a workflow error occurs while creating the process

javax.ejb.CreateException - if the process could not be created

TransactionDemarcationException - if a transaction error occurs

javax.ejb.EJBException - A system-level error occurred

deployProcessForImport

void deployProcessForImport(java.lang.String pWorkspaceId,
                          java.lang.String pUsername,
                          java.lang.String pComment,
                          java.lang.String[] pTargets)
                            throws javax.ejb.FinderException,
                                   javax.jms.JMSException,
                                   WorkflowException,
                                   VersionException,
                                   atg.workflow.process.action.VersionConflictException,
                                   atg.epub.project.AssetLockException,
                                   LockManagerException,
                                   PublishingException,
                                   TransactionDemarcationException,
                                   javax.ejb.EJBException

Used by import tools for process deployment

Parameters:

pWorkspaceId - The workspace id of the project to deploy

pUsername - A username to use for checkin identity

pComment - An optional checkin comment

pTargets - The names of the targets to deploy to

Throws:

javax.ejb.FinderException - If the process to deploy cannot be found

javax.jms.JMSException - If a messaging exception occurs

WorkflowException - If a workflow exception occurs

VersionException - If a version manager exception occurs

atg.workflow.process.action.VersionConflictException - If there is a version conflict during the checkin

atg.epub.project.AssetLockException - If assets are locked by another process

LockManagerException - If an asset lock cannot be acquired

PublishingException - If an error occurs in publishing

TransactionDemarcationException - If a transaction error occurs

javax.ejb.EJBException - A system-level error occurred

initializeProcess

Process initializeProcess(Process pBeanProcess,
                        java.lang.String pWorkflowName)
                          throws ActionException,
                                 WorkflowException,
                                 javax.ejb.CreateException,
                                 TransactionDemarcationException,
                                 javax.ejb.EJBException

This method creates a process. CreateProcess calls this method. This method allows you to set additional process properties on creation. In order to create a bean implementation of a process, do the following: ProcessHome beanProcessHome = ProjectConstants.getBeanHomes().getProcessHome(); ProcessHome persistentProcessHome = ProjectConstants.getPersistentHomes().getProcessHome(); Process process = beanProcessHome.create(); process.setDisplayName(pProcessName); Process persistentProcess = persistentProcessHome.initializeProcess(process, pWorkflowName);

Parameters:

pBeanProcess - A bean implementation of a process

pWorkflowName - The name of the workflow to use for the process, for example '/Content Administration/editAssets.wdl'

Returns:

A persistent implementation of a process

Throws:

ActionException - If an error occurs in the workflow when the process is created

WorkflowException - If a workflow error occurs while creating the process

javax.ejb.CreateException - If the process could not be created

TransactionDemarcationException - If a transaction error occurs

javax.ejb.EJBException - A system-level error occurred

initializeProcess

Process initializeProcess(Process pBeanProcess,
                        java.lang.String pWorkflowName,
                        java.lang.String pSegmentName)
                          throws ActionException,
                                 WorkflowException,
                                 javax.ejb.CreateException,
                                 TransactionDemarcationException,
                                 javax.ejb.EJBException

This method creates a process. CreateProcess calls this method. This method allows you to set additional process properties on creation. In order to create a bean implementation of a process, do the following: ProcessHome beanProcessHome = ProjectConstants.getBeanHomes().getProcessHome(); ProcessHome persistentProcessHome = ProjectConstants.getPersistentHomes().getProcessHome(); Process process = beanProcessHome.create(); process.setDisplayName(pProcessName); Process persistentProcess = persistentProcessHome.initializeProcess(process, pWorkflowName);

Parameters:

pBeanProcess - A bean implementation of a process

pWorkflowName - The name of the workflow to use for the process, for example '/Content Administration/editAssets.wdl'

pSegmentName - The name of the segment to use for the process, for example 'main'

Returns:

A persistent implementation of a process

Throws:

ActionException - If an error occurs in the workflow when the process is created

WorkflowException - If a workflow error occurs while creating the process

javax.ejb.CreateException - If the process could not be created

TransactionDemarcationException - If a transaction error occurs

javax.ejb.EJBException - A system-level error occurred

initializeProcessWithGlobalWorkflow

Process initializeProcessWithGlobalWorkflow(Process pBeanProcess,
                                          java.lang.String pWorkflowName)
                                            throws ActionException,
                                                   WorkflowException,
                                                   javax.ejb.CreateException,
                                                   TransactionDemarcationException,
                                                   javax.ejb.EJBException

Same as initializeProcess() except that it does not require a valid session to be bound to create the process

Parameters:

pBeanProcess - A bean implementation of a process

pWorkflowName - The name of the workflow to use for the process, for example '/Content Administration/editAssets.wdl'

Returns:

A persistent implementation of a process

Throws:

ActionException - If an error occurs in the workflow when the process is created

WorkflowException - If a workflow error occurs while creating the process

javax.ejb.CreateException - If the process could not be created

TransactionDemarcationException - If a transaction error occurs

javax.ejb.EJBException - A system-level error occurred