Package ch.ivyteam.ivy.bpm.engine.client
Class TaskSelector
- java.lang.Object
-
- ch.ivyteam.ivy.bpm.engine.client.TaskSelector
-
public final class TaskSelector extends Object
Select an active task of an execution result.- Since:
- 9.1
- API:
- This is a public API.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Optional<ITask>
activator(IRole role)
Selects an active task by the activator roleOptional<ITask>
activator(IUser user)
Selects an active task by the activator userOptional<ITask>
activatorRole(String roleName)
Selects an active task by the activator role nameOptional<ITask>
activatorUser(String userName)
Selects an active task by the activator user nameStringSelector<Optional<ITask>>
name()
Selects an active task by the its nameOptional<ITask>
name(String name)
Selects an active task by the given nameOptional<ITask>
system()
Selects an active system task.
-
-
-
Method Detail
-
name
public Optional<ITask> name(String name)
Selects an active task by the given nameExample:
var result = bpmClient.start().process(startElement).execute(); assertThat(result.workflow().activeTask().name("Task")).isPresent();
- Parameters:
name
- the task name- Returns:
- selected task or empty
- See Also:
name()
- API:
- This public API is available in Java.
-
name
public StringSelector<Optional<ITask>> name()
Selects an active task by the its nameExample:
var result = bpmClient.start().process(startElement).execute(); assertThat(result.workflow().activeTask().name().contains("Task")).isPresent();
- Returns:
- task name selector to further select the task
- See Also:
name(String)
- API:
- This public API is available in Java.
-
activatorUser
public Optional<ITask> activatorUser(String userName)
Selects an active task by the activator user nameExample:
var result = bpmClient.start().process(startElement).execute(); assertThat(result.workflow().activeTask().activatorUser("User")).isPresent();
- Parameters:
userName
-- Returns:
- selected task or empty
- API:
- This public API is available in Java.
-
activatorRole
public Optional<ITask> activatorRole(String roleName)
Selects an active task by the activator role nameExample:
var result = bpmClient.start().process(startElement).execute(); assertThat(result.workflow().activeTask().activatorRole("Role")).isPresent();
- Parameters:
roleName
-- Returns:
- selected task or empty
- API:
- This public API is available in Java.
-
activator
public Optional<ITask> activator(IUser user)
Selects an active task by the activator userExample:
var result = bpmClient.start().process(startElement).execute(); assertThat(result.workflow().activeTask().activator(user)).isPresent();
- Parameters:
user
-- Returns:
- selected task or empty
- API:
- This public API is available in Java.
-
activator
public Optional<ITask> activator(IRole role)
Selects an active task by the activator roleExample:
var result = bpmClient.start().process(startElement).execute(); assertThat(result.workflow().activeTask().activator(role)).isPresent();
- Parameters:
role
-- Returns:
- selected task or empty
- API:
- This public API is available in Java.
-
system
public Optional<ITask> system()
Selects an active system task. Same as search for task with activator user "SYSTEM".Example:
var result = bpmClient.start().process(startElement).execute(); assertThat(result.workflow().activeTask().system()).isPresent();
- Returns:
- selected system task or empty
- See Also:
activatorUser(String)
- API:
- This public API is available in Java.
-
-