org.camunda.community.bpmndt.model

Interface TestCaseActivityScope

public interface TestCaseActivityScope

Scope (embedded sub process) of one or more test case activities.

Method Summary

Modifier and Type	Method and Description
List<TestCaseActivity>	getActivities() Gets the scope's activities.
org.camunda.bpm.model.bpmn.instance.FlowNode	getFlowNode() Gets the underlying flow node.
<T extends org.camunda.bpm.model.bpmn.instance.SubProcess> T	getFlowNode(Class<T> subProcessType) Gets the underlying flow node of the given sub process type.
String	getId() Returns the ID of the underlying flow node.
String	getName() Returns the name of the underlying flow node.
int	getNestingLevel() Determines how deep the scope is nested within the BPMN process.
TestCaseActivityScope	getParent() Return the parent scope, if the scope is not a direct child of the related BPMN process element.
String	getTypeName() Returns the name of the flow node element type.
boolean	hasParent() Determines if the scope has a parent or if it is a direct child of the BPMN process element.
boolean	isMultiInstance() Determines if the scope is a multi instance.
boolean	isMultiInstanceParallel() Determines if the scope is a parallel multi instance.
boolean	isMultiInstanceSequential() Determines if the scope is a sequential multi instance.

Method Detail

getActivities

List<TestCaseActivity> getActivities()

Gets the scope's activities.

Returns:

A list of activities that have the scope as parent.

getFlowNode

org.camunda.bpm.model.bpmn.instance.FlowNode getFlowNode()

Gets the underlying flow node.

Returns:

The scope's flow node.

getFlowNode

<T extends org.camunda.bpm.model.bpmn.instance.SubProcess> T getFlowNode(Class<T> subProcessType)

Gets the underlying flow node of the given sub process type.

Type Parameters:

T - A sub process type..

Parameters:

subProcessType - A specific sub process type.

Returns:

The typed flow node.

getId

String getId()

Returns the ID of the underlying flow node.

Returns:

The scope ID.

getName

String getName()

Returns the name of the underlying flow node.

Returns:

The scope name.

getNestingLevel

int getNestingLevel()

Determines how deep the scope is nested within the BPMN process. Level 0, means that the scope is not nested in another scope (embedded sub process).

Returns:

The scope's nesting level.

getParent

TestCaseActivityScope getParent()

Return the parent scope, if the scope is not a direct child of the related BPMN process element.

Returns:

The parent test case activity scope.

Throws:

IllegalStateException - If the scope has no parent.

See Also:

hasParent()

getTypeName

String getTypeName()

Returns the name of the flow node element type.

Returns:

The type name.

hasParent

boolean hasParent()

Determines if the scope has a parent or if it is a direct child of the BPMN process element.

Returns:

true, if the scope has a parent scope. Otherwise false.

isMultiInstance

boolean isMultiInstance()

Determines if the scope is a multi instance.

Returns:

true, if the scope is a multi instance. Otherwise false.

isMultiInstanceParallel

boolean isMultiInstanceParallel()

Determines if the scope is a parallel multi instance.

Returns:

true, if the scope is a parallel multi instance. Otherwise false.

Throws:

IllegalStateException - If the scope is not a multi instance.

isMultiInstanceSequential

boolean isMultiInstanceSequential()

Determines if the scope is a sequential multi instance.

Returns:

true, if the scope is a sequential multi instance. Otherwise false.

Throws:

IllegalStateException - If the scope is not a multi instance.