Activiti

Clean up API

Details

  • Type: Improvement Improvement
  • Status: Resolved Resolved
  • Priority: Major Major
  • Resolution: Won't Fix
  • Affects Version/s: None
  • Fix Version/s: 5.0.beta1
  • Component/s: Engine
  • Labels:
    None
  • Number of attachments :
    0

Description

Various API cleaning and javadoc improvements

Activity

Ascending order - Click to sort in descending order
Tom Baeyens made changes -
Field Original Value New Value
Description API
* Use case for exposing executions
 - sending an external event to a receive task
 - show current activities in diagram in webapps

Conclusions
* Both ProcessInstance and Execution need to be exposed
* Execution will expose parent-child relations
* find methods that return a list will be moved to query api
* findXxxById will be renamed to getXxxxById
* findExecutionInActivity

Concrete actions
* keep ProcessService.findExecutionById (it's currently not used)
* add Map<String, Object> ProcessService.getLocalVariables(String executionId); and all analogue methods
* remove Execution.isEnded
* add parent-child relation on Execution interface 		Use case for exposing executions in the API
 - sending an external event to a receive task
 - show current activities in diagram in webapps

Use cases for adding test convenience:
 - check if a process instance is ended
 - check if there is exactly 1 execution in a given activity
 - verify the set of activity names currently active

Conclusions
* Both ProcessInstance and Execution need to be exposed
* Execution will expose parent-child relations
* find methods that return a list will be moved to query api
* findXxxById will be renamed to getXxxxById
* remove findExecutionInActivity
* keep ProcessService.findExecutionById. that will return a full process instance execution true
* add Map<String, Object> ProcessService.getLocalVariables(String executionId); and all analogue methods
* remove Execution.isEnded
* add parent-child relation on Execution interface
Tom Baeyens made changes -
Description Use case for exposing executions in the API
 - sending an external event to a receive task
 - show current activities in diagram in webapps

Use cases for adding test convenience:
 - check if a process instance is ended
 - check if there is exactly 1 execution in a given activity
 - verify the set of activity names currently active

Conclusions
* Both ProcessInstance and Execution need to be exposed
* Execution will expose parent-child relations
* find methods that return a list will be moved to query api
* findXxxById will be renamed to getXxxxById
* remove findExecutionInActivity
* keep ProcessService.findExecutionById. that will return a full process instance execution true
* add Map<String, Object> ProcessService.getLocalVariables(String executionId); and all analogue methods
* remove Execution.isEnded
* add parent-child relation on Execution interface 		Use case for exposing executions in the API
 - sending an external event to a receive task
 - show current activities in diagram in webapps

Use cases for adding test convenience:
 - check if a process instance is ended
 - check if there is exactly 1 execution in a given activity
 - verify the set of activity names currently active

Concrete updates
* Both ProcessInstance and Execution need to be exposed
* Execution must expose parent-child relations (eager loaded)
* remove Execution.isEnded
* keep ProcessService.findExecutionById. that will return a full process instance execution true
* remove findExecutionInActivity
* find methods that return a list will be moved to query api
* findXxxById will be renamed to getXxxxById
* add Map<String, Object> ProcessService.getLocalVariables(String executionId); and all analogue methods
Tom Baeyens made changes -
Fix Version/s 5.0.alpha3 [ 16573 ]
Joram Barrez made changes -
Fix Version/s 5.0.alpha4 [ 16574 ]
Fix Version/s 5.0.alpha3 [ 16573 ]
Tom Baeyens made changes -
Fix Version/s 5.0.beta1 [ 16575 ]
Fix Version/s 5.0.alpha4 [ 16574 ]
Hide
Permalink
Tom Baeyens added a comment -

partially out of date, partially fixed

Show
Tom Baeyens added a comment - partially out of date, partially fixed
Tom Baeyens made changes -
Resolution Won't Fix [ 2 ]
Status Open [ 1 ] Resolved [ 5 ]
Fix Version/s 5.0.beta1 [ 16575 ]
Tom Baeyens made changes -
Summary Improve process service API Clean up API
Fix Version/s 5.0.beta1 [ 16575 ]
Description Use case for exposing executions in the API
 - sending an external event to a receive task
 - show current activities in diagram in webapps

Use cases for adding test convenience:
 - check if a process instance is ended
 - check if there is exactly 1 execution in a given activity
 - verify the set of activity names currently active

Concrete updates
* Both ProcessInstance and Execution need to be exposed
* Execution must expose parent-child relations (eager loaded)
* remove Execution.isEnded
* keep ProcessService.findExecutionById. that will return a full process instance execution true
* remove findExecutionInActivity
* find methods that return a list will be moved to query api
* findXxxById will be renamed to getXxxxById
* add Map<String, Object> ProcessService.getLocalVariables(String executionId); and all analogue methods
Various API cleaning and javadoc improvements
Component/s Engine [ 14460 ]

People

  • Assignee:
    Tom Baeyens
    Reporter:
    Tom Baeyens
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: