Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.jbpm.workflow.definition
Interface DefinitionComponent  view DefinitionComponent download DefinitionComponent.java


public interface DefinitionComponent

is the session facade that exposes the interface for loading process definitions into the process engine.

For an introduction on how to build process definitions please refer to 'The jBpm Process definition language' (jPdl) on the jBpm website. Also the DTD and XSD of the processdefinition.xml file can be found there.

For more information on how jBpm copes with multiple versions of the same process definition, see section 'Versioning' on the jBpm website.


Method Summary
 void deployProcessArchive(java.util.jar.JarInputStream processArchiveStream)
          deploys a process archive into the jBpm runtime engine.
 java.util.Collection getAllProcessDefinitions()
          retrievses all process definitions, including older versions.
 java.util.Collection getAllProcessDefinitions(org.jbpm.util.client.Relations relations)
          retrievses all process definitions, including older versions.
 ProcessDefinition getProcessDefinition(java.lang.Long processDefinitionId)
          gets a specific version of a ProcessDefinition.
 ProcessDefinition getProcessDefinition(java.lang.Long processDefinitionId, org.jbpm.util.client.Relations relations)
          gets a specific version of a ProcessDefinition.
 ProcessDefinition getProcessDefinition(java.lang.String processDefinitionName)
          gets the latest version of the ProcessDefinition with the given name.
 ProcessDefinition getProcessDefinition(java.lang.String processDefinitionName, org.jbpm.util.client.Relations relations)
          gets the latest version of the ProcessDefinition with the given name.
 java.util.Collection getProcessDefinitions()
          collects the highest version of every ProcessDefinition.
 java.util.Collection getProcessDefinitions(org.jbpm.util.client.Relations relations)
          collects the highest version of every ProcessDefinition.
 

Method Detail

deployProcessArchive

public void deployProcessArchive(java.util.jar.JarInputStream processArchiveStream)
                          throws JpdlException
deploys a process archive into the jBpm runtime engine. The contents of the process archive is parsed and stored in the database. A process archive contains one process definition. If a process definition with the same name already exists in the jBpm-engine, the added definition will get a new version number (one higher then the highest existing version number for that name)


getProcessDefinitions

public java.util.Collection getProcessDefinitions()
collects the highest version of every ProcessDefinition. Those are the ProcessDefinitions from which a user must choose one to start. See also versioning.


getProcessDefinitions

public java.util.Collection getProcessDefinitions(org.jbpm.util.client.Relations relations)
collects the highest version of every ProcessDefinition. Those are the ProcessDefinitions from which a user must choose one to start. See also versioning.


getProcessDefinition

public ProcessDefinition getProcessDefinition(java.lang.String processDefinitionName)
gets the latest version of the ProcessDefinition with the given name.


getProcessDefinition

public ProcessDefinition getProcessDefinition(java.lang.String processDefinitionName,
                                              org.jbpm.util.client.Relations relations)
gets the latest version of the ProcessDefinition with the given name.


getProcessDefinition

public ProcessDefinition getProcessDefinition(java.lang.Long processDefinitionId)
gets a specific version of a ProcessDefinition.


getProcessDefinition

public ProcessDefinition getProcessDefinition(java.lang.Long processDefinitionId,
                                              org.jbpm.util.client.Relations relations)
gets a specific version of a ProcessDefinition.


getAllProcessDefinitions

public java.util.Collection getAllProcessDefinitions()
retrievses all process definitions, including older versions.


getAllProcessDefinitions

public java.util.Collection getAllProcessDefinitions(org.jbpm.util.client.Relations relations)
retrievses all process definitions, including older versions.