Package org.camunda.bpm.engine.test.assertions.bpmn

Class TaskAssert

java.lang.Object

org.assertj.core.api.AbstractAssert<S,A>

org.camunda.bpm.engine.test.assertions.bpmn.AbstractProcessAssert<TaskAssert,Task>

org.camunda.bpm.engine.test.assertions.bpmn.TaskAssert

All Implemented Interfaces:

org.assertj.core.api.Assert<TaskAssert,Task>, org.assertj.core.api.Descriptable<TaskAssert>, org.assertj.core.api.ExtensionPoints<TaskAssert,Task>

public class TaskAssert
extends AbstractProcessAssert<TaskAssert,Task>

Assertions for a Task.

Field Summary

Fields inherited from class org.camunda.bpm.engine.test.assertions.bpmn.AbstractProcessAssert

engine

Fields inherited from class org.assertj.core.api.AbstractAssert

actual, info, myself, objects, throwUnsupportedExceptionOnEquals

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TaskAssert(ProcessEngine engine, Task actual)

Method Summary

Modifier and Type	Method	Description
protected static TaskAssert	assertThat(ProcessEngine engine, Task actual)
protected Task	getCurrent()
TaskAssert	hasCandidateGroup(String candidateGroupId)	Verifies the expectation that the Task is currently waiting to be assigned to a user of the specified candidate group.
TaskAssert	hasCandidateGroupAssociated(String candidateGroupId)	Verifies the expectation that the Task is currently associated to the specified candidate group - no matter whether it is already assigned to a specific user or not.
TaskAssert	hasCandidateUser(String candidateUserId)	Verifies the expectation that the Task is currently waiting to be assigned to a specified candidate user.
TaskAssert	hasCandidateUser(String candidateUserId, boolean unassignedOnly)
TaskAssert	hasCandidateUserAssociated(String candidateUserId)	Verifies the expectation that the Task is currently associated to the specified candidate user - no matter whether it is already assigned to a specific user or not.
TaskAssert	hasDefinitionKey(String taskDefinitionKey)	Verifies the definition key of a Task.
TaskAssert	hasDescription(String description)	Verifies the description of a Task.
TaskAssert	hasDueDate(Date dueDate)	Verifies the due date of a Task.
TaskAssert	hasFormKey(String formKey)	Verifies the expectation that the Task has a specified form key.
TaskAssert	hasId(String id)	Verifies the internal id of a Task.
TaskAssert	hasName(String name)	Verifies the name (label) of a Task.
TaskAssert	isAssignedTo(String userId)	Verifies the expectation that the Task is currently assigned to the specified user.
TaskAssert	isNotAssigned()	Verifies the expectation that the Task is currently not assigned to any particular user.
protected TaskQuery	taskQuery()
protected String	toString(Task task)

Methods inherited from class org.camunda.bpm.engine.test.assertions.bpmn.AbstractProcessAssert

caseDefinitionQuery, caseExecutionQuery, caseInstanceQuery, caseService, executionQuery, externalTaskQuery, externalTaskService, formService, getActual, getExistingCurrent, getLastAssert, historicActivityInstanceQuery, historicCaseActivityInstanceQuery, historicProcessInstanceQuery, historicVariableInstanceQuery, historyService, jobQuery, managementService, processDefinitionQuery, processInstanceQuery, repositoryService, resetLastAsserts, runtimeService, taskService

Methods inherited from class org.assertj.core.api.AbstractAssert

asInstanceOf, asList, assertionError, asString, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, doesNotHaveSameHashCodeAs, doesNotHaveToString, equals, extracting, extracting, failure, failureWithActualExpected, failWithActualExpectedAndMessage, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasSameHashCodeAs, hasToString, inBinary, inHexadecimal, is, isElementOfCustomAssert, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isInstanceOfSatisfying, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, matches, matches, newListAssertInstance, overridingErrorMessage, overridingErrorMessage, satisfies, satisfies, satisfies, satisfiesAnyOf, satisfiesAnyOf, satisfiesAnyOfForProxy, satisfiesForProxy, setCustomRepresentation, setDescriptionConsumer, setPrintAssertionsDescription, throwAssertionError, usingComparator, usingComparator, usingDefaultComparator, usingRecursiveComparison, usingRecursiveComparison, withFailMessage, withFailMessage, withRepresentation, withThreadDumpOnError

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.assertj.core.api.Descriptable

as, as, as, describedAs

Constructor Detail

TaskAssert

protected TaskAssert(ProcessEngine engine,
                     Task actual)

Method Detail

assertThat

protected static TaskAssert assertThat(ProcessEngine engine,
                                       Task actual)

getCurrent

protected Task getCurrent()

Specified by:

getCurrent in class AbstractProcessAssert<TaskAssert,Task>

isNotAssigned

public TaskAssert isNotAssigned()

Verifies the expectation that the Task is currently not assigned to any particular user.

Returns:

this TaskAssert

isAssignedTo

public TaskAssert isAssignedTo(String userId)

Verifies the expectation that the Task is currently assigned to the specified user.

Parameters:

userId - id of the user the task should be currently assigned to.

Returns:

this TaskAssert

hasCandidateGroup

public TaskAssert hasCandidateGroup(String candidateGroupId)

Verifies the expectation that the Task is currently waiting to be assigned to a user of the specified candidate group.

Parameters:

candidateGroupId - id of a candidate group the task is waiting to be assigned to

Returns:

this TaskAssert

Since:

Camunda Platform 7.0

hasCandidateGroupAssociated

public TaskAssert hasCandidateGroupAssociated(String candidateGroupId)

Verifies the expectation that the Task is currently associated to the specified candidate group - no matter whether it is already assigned to a specific user or not.

Parameters:

candidateGroupId - id of a candidate group the task is associated to

Returns:

this TaskAssert

Since:

Camunda Platform 7.3

hasCandidateUser

public TaskAssert hasCandidateUser(String candidateUserId)

Verifies the expectation that the Task is currently waiting to be assigned to a specified candidate user.

Parameters:

candidateUserId - id of a candidate user the task is waiting to be assigned to

Returns:

this TaskAssert

Since:

Camunda Platform 7.0

hasCandidateUserAssociated

public TaskAssert hasCandidateUserAssociated(String candidateUserId)

Verifies the expectation that the Task is currently associated to the specified candidate user - no matter whether it is already assigned to a specific user or not.

Parameters:

candidateUserId - id of a candidate user the task is associated to

Returns:

this TaskAssert

Since:

Camunda Platform 7.3

hasCandidateUser

public TaskAssert hasCandidateUser(String candidateUserId,
                                   boolean unassignedOnly)

hasDueDate

public TaskAssert hasDueDate(Date dueDate)

Verifies the due date of a Task.

Parameters:

dueDate - the date the task should be due at

Returns:

this TaskAssert

hasDefinitionKey

public TaskAssert hasDefinitionKey(String taskDefinitionKey)

Verifies the definition key of a Task. This key can be found in the <userTask id="myTaskDefinitionKey" .../> attribute of the process definition BPMN 2.0 XML file.

Parameters:

taskDefinitionKey - the expected value of the task/@id attribute

Returns:

this TaskAssert

hasFormKey

public TaskAssert hasFormKey(String formKey)

Verifies the expectation that the Task has a specified form key.

Parameters:

formKey - the expected form key.

Returns:

this TaskAssert

hasId

public TaskAssert hasId(String id)

Verifies the internal id of a Task.

Parameters:

id - the expected value of the internal task id

Returns:

this TaskAssert

hasName

public TaskAssert hasName(String name)

Verifies the name (label) of a Task. This name can be found in the <userTask name="myName" .../> attribute of the process definition BPMN 2.0 XML file.

Parameters:

name - the expected value of the name

Returns:

this TaskAssert

hasDescription

public TaskAssert hasDescription(String description)

Verifies the description of a Task. This description can be found in the <userTask><documentation>description</documentation></userTask> element of the process definition BPMN 2.0 XML file.

Parameters:

description - the expected value of the description

Returns:

this TaskAssert

toString

protected String toString(Task task)

Specified by:

toString in class AbstractProcessAssert<TaskAssert,Task>

taskQuery

protected TaskQuery taskQuery()

Overrides:

taskQuery in class AbstractProcessAssert<TaskAssert,Task>