de.danet.an.workflow.api
Interface ProcessDirectory

All Superinterfaces:

WfObject

public interface ProcessDirectory

extends WfObject

Client interface for the process directory.

Method Summary

Activity	lookupActivity(ActivityUniqueKey key) This method returns the activity identified be the given unique key.
Activity.Info	lookupActivityInfo(ActivityUniqueKey key) This method finds the activity identified be the given unique key and returns all available information about it.
Process	lookupProcess(java.lang.String processMgrName, java.lang.String processKey) This method finds the process identified by the given type and key.
java.util.Collection	processes() This operation method delivers a collection of all known processes.
java.util.Collection	processMgrNames() This operation method returns a collection of the defined process types as Strings.
void	removeProcess(WfProcess process) Removes the given process.

Method Detail

processMgrNames

public java.util.Collection processMgrNames()
                                     throws java.rmi.RemoteException

This operation method returns a collection of the defined process types as Strings.

Returns:

collection of String

Throws:

java.rmi.RemoteException - if a system-level error occurs.

processes

public java.util.Collection processes()
                               throws java.rmi.RemoteException

This operation method delivers a collection of all known processes. The objects of the collection are remote interface of type Process.

Returns:

collection of Process

Throws:

java.rmi.RemoteException - if a system-level error occurs.

lookupProcess

public Process lookupProcess(java.lang.String processMgrName,
                             java.lang.String processKey)
                      throws InvalidKeyException,
                             java.rmi.RemoteException

This method finds the process identified by the given type and key.

Parameters:

processMgrName - type of the given process.

processKey - key of the process.

Returns:

the process found.

Throws:

InvalidKeyException - if no such process can be found.

java.rmi.RemoteException - if a system-level error occurs.

lookupActivity

public Activity lookupActivity(ActivityUniqueKey key)
                        throws InvalidKeyException,
                               java.rmi.RemoteException

This method returns the activity identified be the given unique key.

Parameters:

key - denotes the activity to be looked up.

Returns:

the corresponding Activity value

Throws:

java.rmi.RemoteException - if a system-level error occurs.

InvalidKeyException - if the activity specified by key cannot be found.

lookupActivityInfo

public Activity.Info lookupActivityInfo(ActivityUniqueKey key)
                                 throws InvalidKeyException,
                                        java.rmi.RemoteException

This method finds the activity identified be the given unique key and returns all available information about it. This is a shortcut for first looking up the activity and then retrieving the "essential" information about it.

Parameters:

key - denotes the activity to be looked up.

Returns:

the corresponding Activity.Info value

Throws:

InvalidKeyException - if the activity specified by key cannot be found.

java.rmi.RemoteException - if a system-level error occurs.

removeProcess

public void removeProcess(WfProcess process)
                   throws java.rmi.RemoteException,
                          CannotRemoveException

Removes the given process. The process can be removed, only if it is in state "closed" or "not started".

Parameters:

process - the process to remove.

Throws:

java.rmi.RemoteException - if a system-level error occurs.

CannotRemoveException - if the process cannot be removed, because it is still in progress.