Package ch.ivyteam.ivy.bpm.engine.client.start

Class ByBuilder

java.lang.Object

ch.ivyteam.ivy.bpm.engine.client.start.ByBuilder

public class ByBuilder
extends Object

Define the way to start your process.

Since:

9.1

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
RequestBuilder	anyActiveTask(ExecutionResult previousResult)	Resume the workflow with the first active task found on the previous result.
RequestBuilder	process(BpmElement start)	Start a process at a given element.
RequestBuilder	process(BpmProcess process)	Start a process by the given process element.
RequestBuilder	process(String requestPath)	Start a process with a given path (reference a deployed IProcessStart).
SubRequestBuilder	subProcess(BpmElement subStart)	Starts the callable sub process at the given element
SubRequestBuilder	subProcess(BpmProcess callableSubProcess)	Starts the given callable sub process
RequestBuilder	task(ITask task)	Resume process at the given task.
RequestBuilder	task(Optional<ITask> task)	Resume process at the given task.

Method Detail

process

public RequestBuilder process(String requestPath)

Start a process with a given path (reference a deployed IProcessStart).

Example:

 bpmClient.start().process("MyProcess/start1.ivp").execute();
 

Request path can be defined as:

• technical path '11E1FE9BBB052AC3/start1.ivp'
• human readable path 'MyProcess/start1.ivp'
• process path 'MyProcess'. Given that only one start exists in the target process

Parameters:

requestPath -

Returns:

request builder for further request construction

API:

This public API is available in Java.

process

public RequestBuilder process(BpmProcess process)

Start a process by the given process element.

Example:

 var process = BpmProcess.name("processUnderTest");
 bpmClient.start().process(process).execute();
 

Parameters:

process -

Returns:

request builder for further request construction

API:

This public API is available in Java.

process

public RequestBuilder process(BpmElement start)

Start a process at a given element.

Example:

 var startElement = BpmElement.processName("processUnderTest").name("start.ivp");
 bpmClient.start().process(startElement).execute();
 

Parameters:

start -

Returns:

request builder for further request construction

API:

This public API is available in Java.

subProcess

public SubRequestBuilder subProcess(BpmProcess callableSubProcess)

Starts the given callable sub process

Parameters:

callableSubProcess -

Returns:

request builder for further request construction

Since:

9.2

API:

This public API is available in Java.

subProcess

public SubRequestBuilder subProcess(BpmElement subStart)

Starts the callable sub process at the given element

Parameters:

subStart - callable sub start event process element where to start the callable sub process

Returns:

request builder for further request construction

Since:

9.2

API:

This public API is available in Java.

task

public RequestBuilder task(ITask task)

Resume process at the given task.

Example:

 bpmClient.start().task(task).execute();
 

Parameters:

task -

Returns:

request builder for further request construction

See Also:

task(Optional), anyActiveTask(ExecutionResult)

API:

This public API is available in Java.

task

public RequestBuilder task(Optional<ITask> task)

Resume process at the given task.

Parameters:

task - as optional

Returns:

request builder for further request construction

Throws:

IllegalArgumentException - if task is empty

See Also:

task(ITask), anyActiveTask(ExecutionResult)

API:

This public API is available in Java.

anyActiveTask

public RequestBuilder anyActiveTask(ExecutionResult previousResult)

Resume the workflow with the first active task found on the previous result. It will set the session of the builder to the result session.

Parameters:

previousResult -

Returns:

request builder for further request construction

Throws:

IllegalArgumentException - if no active task was found on the result

See Also:

Workflow.anyActiveTask(), task(ITask), task(Optional)

API:

This public API is available in Java.