de.danet.an.workflow.api
Interface ProcessMgr

All Superinterfaces:
WfObject, WfProcessMgr

public interface ProcessMgr
extends WfProcessMgr

Interface ProcessMgr adds some functions to the OMG process manager.

The meta information returned by contextSignature and resultSignature defined in WfProcessMgr uses Java classes to represents primitive types, as specified for ProcessDataInfo. In addition the type of a data item can be indicated as

org.w3c.dom.Element.class
denotes XML with unknown structure. Values of this type are represented as instances of SAXEventBuffer.
an instance of SAXEventBuffer
denotes XML with the known structure represented by the XML in the event buffer. Values of this type are represented as instances of SAXEventBuffer.
an instance of ExternalReference
denotes the type as specified in the process definition. If a Java type is specified as fully qualified Java class name in the localtion attribute, "java:" is prepended as protocol and values are of the specified type. Else values of this type are represented as instances of SAXEventBuffer.


Field Summary
 
Fields inherited from interface de.danet.an.workflow.omgcore.WfProcessMgr
DISABLED, ENABLED
 
Method Summary
 java.util.Collection findByDataItem(java.lang.String itemName, java.lang.String itemValue)
          Returns all Processes that have a given value in a particular process data item.
 Process processByKey(java.lang.String key)
          Returns the Process with the given key.
 
Methods inherited from interface de.danet.an.workflow.omgcore.WfProcessMgr
category, contextSignature, createProcess, description, name, processes, processMgrState, resultSignature, setProcessMgrState, version
 

Method Detail

processByKey

public Process processByKey(java.lang.String key)
                     throws java.rmi.RemoteException,
                            InvalidKeyException
Returns the Process with the given key. The OMG interface only defines a method for listing all processes associated with a process manager. While, of course, one could select the process with a certain key from that list, this would be rather inefficient.

Parameters:
key - the key of the process
Returns:
the process associated with the key
Throws:
InvalidKeyException - if no process with the given key exists
java.rmi.RemoteException - if a system-level error occurs

findByDataItem

public java.util.Collection findByDataItem(java.lang.String itemName,
                                           java.lang.String itemValue)
                                    throws java.rmi.RemoteException
Returns all Processes that have a given value in a particular process data item. Note that this method may only be used for data items of type string.

Parameters:
itemName - the name of the process data item
itemValue - the value of the process data item
Returns:
the collection of processes
Throws:
java.rmi.RemoteException - if a system-level error occurs