| de.danet.an.workflow.localapi.ProcessDefinitionDirectoryLocal
All known Subclasses: de.danet.an.workflow.domain.AbstractProcessDefinitionDirectory,
| ProcessDefinitionDirectoryLocal | | public interface ProcessDefinitionDirectoryLocal extends WfObjectLocal(Code) | | This interface defines a process definiton directory.
|
| Method Summary | |
| WfProcessLocal | createProcessLocal(String packageId, String processId, WfRequester requester)
Create a process of the given type with the given requester.
Parameters:
packageId - Id attribute of the process package.
Parameters:
processId - Id attribute of the process.
Parameters:
requester - the requester. | | List | importProcessDefinitions(String processDefinitions)
This operation method import new process definitions from an
XPDL description. | | List | importProcessDefinitions(byte[] processDefinitions)
This operation method import new process definitions from an
XPDL description.
Note that importing an XPDL description automatically removes
any existing process definitions that have the same package id
as the imported package.
Parameters:
processDefinitions - byte array resulting from anInputStream that describes the process definitions. | | boolean | isEnabled(String packageId, String processId)
This operation method returns true if the process definition
with the given ids is enabled.
Parameters:
packageId - Id attribute of the process package.
Parameters:
processId - Id attribute of the process. | | ProcessDefinition | lookupProcessDefinition(String packageId, String processId)
This method delivers the process definition for the
given ids. | | boolean | processDefinitionExists(String packageId, String processId)
This method checks if a process definiton with the given ids
exists.
Parameters:
packageId - Id attribute of the process package.
Parameters:
processId - Id attribute of the process. | | Collection | processDefinitions()
This operation method delivers a collection of all
defined process definitions. | | void | removeProcessDefinition(String packageId, String processId)
This operation method removes a process definition with the
given ids from the database. | | void | setEnabled(String packageId, String processId, boolean enabled)
This operation method set the process definition with the given
ids as enabled or disabled. |
| importProcessDefinitions | | List importProcessDefinitions(String processDefinitions) throws ImportException(Code) | | This operation method import new process definitions from an
XPDL description.
Note that importing an XPDL description automatically removes
any existing process definitions that have the same package id
as the imported package.
Parameters:
processDefinitions - document describing the process definitions. list of prioritized message de.danet.an.workflow.api.PrioritizedMessage PrioritizedMessage. This list only includesmessages of priority INFO or WARN. If any (fatal) error has occured, ande.danet.an.workflow.api.ImportExceptionImportExceptionwill be thrown and the errormessage can be taken from there.
throws:
ImportException - if the input is not a correct. |
| importProcessDefinitions | | List importProcessDefinitions(byte[] processDefinitions) throws ImportException(Code) | | This operation method import new process definitions from an
XPDL description.
Note that importing an XPDL description automatically removes
any existing process definitions that have the same package id
as the imported package.
Parameters:
processDefinitions - byte array resulting from anInputStream that describes the process definitions. list of prioritized message de.danet.an.workflow.api.PrioritizedMessage PrioritizedMessage. This list only includesmessages of priority INFO or WARN. If any (fatal) error has occured, ande.danet.an.workflow.api.ImportExceptionImportExceptionwill be thrown and the errormessage can be taken from there.
throws:
ImportException - if the input is not a correct. |
| isEnabled | | boolean isEnabled(String packageId, String processId) throws InvalidKeyException(Code) | | This operation method returns true if the process definition
with the given ids is enabled.
Parameters:
packageId - Id attribute of the process package.
Parameters:
processId - Id attribute of the process. if the process definition is enabled.
throws:
InvalidKeyException - if no process definition withthe given ids exists. |
| lookupProcessDefinition | | ProcessDefinition lookupProcessDefinition(String packageId, String processId) throws InvalidKeyException(Code) | | This method delivers the process definition for the
given ids. If no process definition with the ids exist, it
throws an IllegalArgumentException.
Parameters:
packageId - Id attribute of the process package.
Parameters:
processId - Id attribute of the process. the found ProcessDefinition object.
throws:
InvalidKeyException - if no process definition withthe given ids exists. |
| processDefinitionExists | | boolean processDefinitionExists(String packageId, String processId)(Code) | | This method checks if a process definiton with the given ids
exists.
Parameters:
packageId - Id attribute of the process package.
Parameters:
processId - Id attribute of the process. true if a process definition with the givenid exists. |
| processDefinitions | | Collection processDefinitions()(Code) | | This operation method delivers a collection of all
defined process definitions. The elements of the list
are of the type
ProcessDefinition ProcessDefinition collection |
| removeProcessDefinition | | void removeProcessDefinition(String packageId, String processId) throws InvalidKeyException(Code) | | This operation method removes a process definition with the
given ids from the database. If called for a definition that
does not exist, it does nothing.
Parameters:
packageId - Id attribute of the process package.
Parameters:
processId - Id attribute of the process.
throws:
InvalidKeyException - if packageId or processId are(formally) invalid ids. |
| setEnabled | | void setEnabled(String packageId, String processId, boolean enabled) throws InvalidKeyException(Code) | | This operation method set the process definition with the given
ids as enabled or disabled.
Parameters:
packageId - Id attribute of the process package.
Parameters:
processId - Id attribute of the process.
Parameters:
enabled - enable the process definition or not.
throws:
InvalidKeyException - if no process definition withthe given ids exists. |
|
|