org.apache.ode.bpel.pmapi
Interface ProcessManagement

All Known Subinterfaces:
BpelManagementFacade

public interface ProcessManagement

Process Management API


Method Summary
 org.apache.ode.bpel.pmapi.ProcessInfoDocument activate(javax.xml.namespace.QName pid)
          Activate a process.
 org.apache.ode.bpel.pmapi.ActivityExtInfoListDocument getExtensibilityElements(javax.xml.namespace.QName pid, java.lang.Integer[] aids)
          Get all extensibility elements associated with provided activity ids.
 org.apache.ode.bpel.pmapi.ProcessInfoDocument getProcessInfo(javax.xml.namespace.QName pid)
          Get the process info for a process (includingthe instance summary).
 org.apache.ode.bpel.pmapi.ProcessInfoDocument getProcessInfoCustom(javax.xml.namespace.QName pid, ProcessInfoCustomizer custom)
          Get the process info for a process.
 org.apache.ode.bpel.pmapi.ProcessInfoListDocument listAllProcesses()
          List the processes known to the engine.
 org.apache.ode.bpel.pmapi.ProcessInfoListDocument listProcesses(java.lang.String filter, java.lang.String orderKeys)
          List the processes known to the engine (including instance summaries).
 org.apache.ode.bpel.pmapi.ProcessInfoListDocument listProcessesCustom(java.lang.String filter, java.lang.String orderKeys, ProcessInfoCustomizer custom)
          List the processes known to the engine.
 org.apache.ode.bpel.pmapi.ProcessInfoListDocument listProcessesSummaryOnly()
          List the processes known to the engine, excluding the document list, properties and end point configs.
 void setPackageRetired(java.lang.String packageName, boolean retired)
          Retires all the processes contained in a package.
 org.apache.ode.bpel.pmapi.ProcessInfoDocument setProcessProperty(javax.xml.namespace.QName pid, javax.xml.namespace.QName propertyName, java.lang.String value)
          Set a process property as a simple type.
 org.apache.ode.bpel.pmapi.ProcessInfoDocument setProcessPropertyNode(javax.xml.namespace.QName pid, javax.xml.namespace.QName propertyName, org.w3c.dom.Node value)
          Set a process property as a Node.
 org.apache.ode.bpel.pmapi.ProcessInfoDocument setRetired(javax.xml.namespace.QName pid, boolean retired)
          Retire a process.
 

Method Detail

listProcesses

org.apache.ode.bpel.pmapi.ProcessInfoListDocument listProcesses(java.lang.String filter,
                                                                java.lang.String orderKeys)
List the processes known to the engine (including instance summaries).

Parameters:
filter - selection filter or null (for no filtering).
orderKeys - keys used to order the results
Returns:
list of ProcessInfoDocuments (including instance summaries)

listProcessesCustom

org.apache.ode.bpel.pmapi.ProcessInfoListDocument listProcessesCustom(java.lang.String filter,
                                                                      java.lang.String orderKeys,
                                                                      ProcessInfoCustomizer custom)
List the processes known to the engine.

Parameters:
filter - selection filter or null (for no filtering).
orderKeys - keys used to order the results
custom - used to customize the quantity of information returned
Returns:
list of ProcessInfoDocuments (including instance summaries)

listAllProcesses

org.apache.ode.bpel.pmapi.ProcessInfoListDocument listAllProcesses()
List the processes known to the engine.

Returns:
list of ProcessInfoDocuments (including instance summaries)

listProcessesSummaryOnly

org.apache.ode.bpel.pmapi.ProcessInfoListDocument listProcessesSummaryOnly()
List the processes known to the engine, excluding the document list, properties and end point configs.

Returns:
list of ProcessInfoDocuments (including instance summaries)

getProcessInfoCustom

org.apache.ode.bpel.pmapi.ProcessInfoDocument getProcessInfoCustom(javax.xml.namespace.QName pid,
                                                                   ProcessInfoCustomizer custom)
                                                                   throws ManagementException
Get the process info for a process.

Parameters:
pid - name of the process
custom - used to customize the quantity of information returned
Returns:
ProcessInfoDocument
Throws:
ManagementException

getProcessInfo

org.apache.ode.bpel.pmapi.ProcessInfoDocument getProcessInfo(javax.xml.namespace.QName pid)
                                                             throws ManagementException
Get the process info for a process (includingthe instance summary).

Parameters:
pid - name of the process
Returns:
ProcessInfoDocument with all details.
Throws:
ManagementException

getExtensibilityElements

org.apache.ode.bpel.pmapi.ActivityExtInfoListDocument getExtensibilityElements(javax.xml.namespace.QName pid,
                                                                               java.lang.Integer[] aids)
Get all extensibility elements associated with provided activity ids. Extensibility elements are extracted from the original BPEL document.

Parameters:
pid - process identifier
aids - activity indentifiers
Returns:
a list of activity extension as ActivityExtInfoListDocument

setProcessPropertyNode

org.apache.ode.bpel.pmapi.ProcessInfoDocument setProcessPropertyNode(javax.xml.namespace.QName pid,
                                                                     javax.xml.namespace.QName propertyName,
                                                                     org.w3c.dom.Node value)
                                                                     throws ManagementException
Set a process property as a Node.

Parameters:
pid - name of process
propertyName - qname of property
value - property value
Returns:
ProcessInfoDocument reflecting the modification
Throws:
ManagementException

setProcessProperty

org.apache.ode.bpel.pmapi.ProcessInfoDocument setProcessProperty(javax.xml.namespace.QName pid,
                                                                 javax.xml.namespace.QName propertyName,
                                                                 java.lang.String value)
                                                                 throws ManagementException
Set a process property as a simple type.

Parameters:
pid - name of process
propertyName - qname of property
value - property value
Returns:
ProcessInfoDocument reflecting the modification
Throws:
ManagementException

activate

org.apache.ode.bpel.pmapi.ProcessInfoDocument activate(javax.xml.namespace.QName pid)
                                                       throws ManagementException
Activate a process.

Parameters:
pid - identifier for the process to load
Returns:
ProcessInfoDocument reflecting the modification
Throws:
ManagementException

setRetired

org.apache.ode.bpel.pmapi.ProcessInfoDocument setRetired(javax.xml.namespace.QName pid,
                                                         boolean retired)
                                                         throws ManagementException
Retire a process.

Parameters:
pid - identifier of the process to retire
retired - TODO
Returns:
ProcessInfoDocument reflecting the modification
Throws:
ManagementException

setPackageRetired

void setPackageRetired(java.lang.String packageName,
                       boolean retired)
Retires all the processes contained in a package.

Parameters:
packageName -
retired -