Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| jBPM :: Distribution 6.2.0.Final
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jbpm.services.api
Interface DefinitionService

All Known Subinterfaces:
  DefinitionServiceEJBLocal, DefinitionServiceEJBRemote

All Known Implementing Classes:
  BPMN2DataServiceCDIImpl, BPMN2DataServiceImpl, DefinitionServiceEJBImpl

    public interface DefinitionService

Provides details from definition point of view which is extracted from BPMN2 definitions. Delivers information about:

- process such as id, name, version
- process variables (name and type)
- defined reusable subprocesses
- defined service tasks (domain specific services)
- defined user tasks
- user task input and outputs

Method Summary
`ProcessDefinition` | `buildProcessDefinition(String deploymentId, String bpmn2Content, ClassLoader classLoader, boolean cache)` Performs build operation for given bpmn2content to produce fully populated `ProcessDefinition`
`Map<String,Collection<String>>` | `getAssociatedEntities(String deploymentId, String processId)` Returns all organizational entities identifiers involved in the process - like users and groups.
`ProcessDefinition` | `getProcessDefinition(String deploymentId, String processId)` Returns previously built `ProcessDefinition`.
`Map<String,String>` | `getProcessVariables(String deploymentId, String processId)` Returns all process variables defined in the given process where: key in the map is name of the process variable value in the map is type of the process variable NOTE: This method assumes process has already been built by invoking `buildProcessDefinition` method
`Collection<String>` | `getReusableSubProcesses(String deploymentId, String processId)` Returns collection of process identifiers of reusable processes used by given process.
`Map<String,String>` | `getServiceTasks(String deploymentId, String processId)` Returns service (domain specific) tasks defined in the process where: key in the map is name of the task node value in the map is name of the domain specific service (name that handler should be registered with) NOTE: This method assumes process has already been built by invoking `buildProcessDefinition` method
`Map<String,String>` | `getTaskInputMappings(String deploymentId, String processId, String taskName)` Returns map of data input defined for given user task key in the map is identifier of dataInput value in the map is name dataInput NOTE: This method assumes process has already been built by invoking `buildProcessDefinition` method
`Map<String,String>` | `getTaskOutputMappings(String deploymentId, String processId, String taskName)` Returns map of data output defined for given user task key in the map is identifier of dataOutput value in the map is name dataOutput NOTE: This method assumes process has already been built by invoking `buildProcessDefinition` method
`Collection<UserTaskDefinition>` | `getTasksDefinitions(String deploymentId, String processId)` Returns all user task definitions defined in given process NOTE: This method assumes process has already been built by invoking `buildProcessDefinition` method

Method Detail

### buildProcessDefinition

    ProcessDefinition buildProcessDefinition(String deploymentId,
                                             String bpmn2Content,
                                             ClassLoader classLoader,
                                             boolean cache)
                                             throws IllegalArgumentException

  Performs build operation for given bpmn2content to produce fully populated `ProcessDefinition`

  Parameters:
    `deploymentId` - identifier of deployment this process belongs to, might be null if built definition does not need to be stored
    `bpmn2Content` - actual BPMN xml content as string to be parsed and processed
    `classLoader` - class loader that should be used while parsing the BPMN2 in case custom classes are referenced
    `cache` - indicates if the definition service should cache this `ProcessDefinition`
  Returns:
    fully populated `ProcessDefinition`
  Throws:
    `IllegalArgumentException` - in case build operation cannot be completed

### getProcessDefinition

    ProcessDefinition getProcessDefinition(String deploymentId,
                                           String processId)

  Returns previously built `ProcessDefinition`.
  NOTE: This method assumes process has already been built by invoking `buildProcessDefinition` method

  Parameters:
    `deploymentId` - identifier of deployment that process belongs to
    `processId` - identifier of the process
  Returns:
    returns complete `ProcessDefinition` if found otherwise null

### getReusableSubProcesses

    Collection<String> getReusableSubProcesses(String deploymentId,
                                               String processId)

  Returns collection of process identifiers of reusable processes used by given process.
  NOTE: This method assumes process has already been built by invoking `buildProcessDefinition` method

  Parameters:
    `deploymentId` - identifier of deployment that process belongs to
    `processId` - identifier of the process
  Returns:
    returns collection of found reusable subprocess identifiers, maybe an empty list if none were found

### getProcessVariables

    Map<String,String> getProcessVariables(String deploymentId,
                                           String processId)

  Returns all process variables defined in the given process where:
  - key in the map is name of the process variable
  - value in the map is type of the process variable
  NOTE: This method assumes process has already been built by invoking `buildProcessDefinition` method

  Parameters:
    `deploymentId` - identifier of deployment that process belongs to
    `processId` - identifier of the process
  Returns:
    map of all process variables defined or empty map in none found

### getServiceTasks

    Map<String,String> getServiceTasks(String deploymentId,
                                       String processId)

  Returns service (domain specific) tasks defined in the process where:
  - key in the map is name of the task node
  - value in the map is name of the domain specific service (name that handler should be registered with)
  NOTE: This method assumes process has already been built by invoking `buildProcessDefinition` method

  Parameters:
    `deploymentId` - identifier of deployment that process belongs to
    `processId` - identifier of the process
  Returns:
    returns map of all found service tasks or empty map if none found

### getAssociatedEntities

    Map<String,Collection<String>> getAssociatedEntities(String deploymentId,
                                                         String processId)

  Returns all organizational entities identifiers involved in the process - like users and groups. Since this is based on definition and not runtime it can return references to process variables
  NOTE: This method assumes process has already been built by invoking `buildProcessDefinition` method

  Parameters:
    `deploymentId` - identifier of deployment that process belongs to
    `processId` - identifier of the process
  Returns:
    returns map of all found organizational entities grouped by task they are assigned to

### getTasksDefinitions

    Collection<UserTaskDefinition> getTasksDefinitions(String deploymentId,
                                                       String processId)

  Returns all user task definitions defined in given process
  NOTE: This method assumes process has already been built by invoking `buildProcessDefinition` method

  Parameters:
    `deploymentId` - identifier of deployment that process belongs to
    `processId` - identifier of the process
  Returns:
    returns collection of `UserTaskDefinition`s or empty collection if none were found

### getTaskInputMappings

    Map<String,String> getTaskInputMappings(String deploymentId,
                                            String processId,
                                            String taskName)

  Returns map of data input defined for given user task
  - key in the map is identifier of dataInput
  - value in the map is name dataInput
  NOTE: This method assumes process has already been built by invoking `buildProcessDefinition` method

  Parameters:
    `deploymentId` - identifier of deployment that process belongs to
    `processId` - identifier of the process
    `taskName` - name of a task the data input should be collected for
  Returns:
    returns map of found data inputs or empty map if none were found

### getTaskOutputMappings

    Map<String,String> getTaskOutputMappings(String deploymentId,
                                             String processId,
                                             String taskName)

  Returns map of data output defined for given user task
  - key in the map is identifier of dataOutput
  - value in the map is name dataOutput
  NOTE: This method assumes process has already been built by invoking `buildProcessDefinition` method

  Parameters:
    `deploymentId` - identifier of deployment that process belongs to
    `processId` - identifier of the process
    `taskName` - name of a task the data output should be collected for
  Returns:
    returns map of found data outputs or empty map if none were found

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| jBPM :: Distribution 6.2.0.Final
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001-2015 JBoss by Red Hat. All Rights Reserved.