Package io.camunda.client.protocol.rest

Class UserTaskFilter

java.lang.Object

io.camunda.client.protocol.rest.UserTaskFilter

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-02-25T13:39:08.081076719Z[GMT]",
           comments="Generator version: 7.10.0")
public class UserTaskFilter
extends Object

User task filter request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UserTaskFilter.StateEnum	The state of the user task.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ASSIGNEE
static final String	JSON_PROPERTY_CANDIDATE_GROUP
static final String	JSON_PROPERTY_CANDIDATE_USER
static final String	JSON_PROPERTY_COMPLETION_DATE
static final String	JSON_PROPERTY_CREATION_DATE
static final String	JSON_PROPERTY_DUE_DATE
static final String	JSON_PROPERTY_ELEMENT_ID
static final String	JSON_PROPERTY_ELEMENT_INSTANCE_KEY
static final String	JSON_PROPERTY_FOLLOW_UP_DATE
static final String	JSON_PROPERTY_LOCAL_VARIABLES
static final String	JSON_PROPERTY_PRIORITY
static final String	JSON_PROPERTY_PROCESS_DEFINITION_ID
static final String	JSON_PROPERTY_PROCESS_DEFINITION_KEY
static final String	JSON_PROPERTY_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_PROCESS_INSTANCE_VARIABLES
static final String	JSON_PROPERTY_STATE
static final String	JSON_PROPERTY_TENANT_ID
static final String	JSON_PROPERTY_USER_TASK_KEY

Constructor Summary

Constructors

Constructor	Description
UserTaskFilter()

Method Summary

Modifier and Type	Method	Description
UserTaskFilter	addLocalVariablesItem(UserTaskVariableFilterRequest localVariablesItem)
UserTaskFilter	addProcessInstanceVariablesItem(UserTaskVariableFilterRequest processInstanceVariablesItem)
UserTaskFilter	assignee(StringFilterProperty assignee)
UserTaskFilter	candidateGroup(StringFilterProperty candidateGroup)
UserTaskFilter	candidateUser(StringFilterProperty candidateUser)
UserTaskFilter	completionDate(DateTimeFilterProperty completionDate)
UserTaskFilter	creationDate(DateTimeFilterProperty creationDate)
UserTaskFilter	dueDate(DateTimeFilterProperty dueDate)
UserTaskFilter	elementId(String elementId)
UserTaskFilter	elementInstanceKey(String elementInstanceKey)
boolean	equals(Object o)
UserTaskFilter	followUpDate(DateTimeFilterProperty followUpDate)
StringFilterProperty	getAssignee()	The assignee of the user task.
StringFilterProperty	getCandidateGroup()	The candidate group for this user task.
StringFilterProperty	getCandidateUser()	The candidate user for this user task.
DateTimeFilterProperty	getCompletionDate()	The user task completion date.
DateTimeFilterProperty	getCreationDate()	The user task creation date.
DateTimeFilterProperty	getDueDate()	The user task due date.
String	getElementId()	The element ID of the user task.
String	getElementInstanceKey()	The key of the element instance.
DateTimeFilterProperty	getFollowUpDate()	The user task follow-up date.
List<UserTaskVariableFilterRequest>	getLocalVariables()	Local variables associated with the user task.
IntegerFilterProperty	getPriority()	The priority of the user task.
String	getProcessDefinitionId()	The ID of the process definition.
String	getProcessDefinitionKey()	The key of the process definition.
String	getProcessInstanceKey()	The key of the process instance.
List<UserTaskVariableFilterRequest>	getProcessInstanceVariables()	Process instance variables associated with the user task.
UserTaskFilter.StateEnum	getState()	The state of the user task.
String	getTenantId()	Tenant ID of this user task.
String	getUserTaskKey()	The key for this user task.
int	hashCode()
UserTaskFilter	localVariables(List<UserTaskVariableFilterRequest> localVariables)
UserTaskFilter	priority(IntegerFilterProperty priority)
UserTaskFilter	processDefinitionId(String processDefinitionId)
UserTaskFilter	processDefinitionKey(String processDefinitionKey)
UserTaskFilter	processInstanceKey(String processInstanceKey)
UserTaskFilter	processInstanceVariables(List<UserTaskVariableFilterRequest> processInstanceVariables)
void	setAssignee(StringFilterProperty assignee)
void	setCandidateGroup(StringFilterProperty candidateGroup)
void	setCandidateUser(StringFilterProperty candidateUser)
void	setCompletionDate(DateTimeFilterProperty completionDate)
void	setCreationDate(DateTimeFilterProperty creationDate)
void	setDueDate(DateTimeFilterProperty dueDate)
void	setElementId(String elementId)
void	setElementInstanceKey(String elementInstanceKey)
void	setFollowUpDate(DateTimeFilterProperty followUpDate)
void	setLocalVariables(List<UserTaskVariableFilterRequest> localVariables)
void	setPriority(IntegerFilterProperty priority)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessInstanceKey(String processInstanceKey)
void	setProcessInstanceVariables(List<UserTaskVariableFilterRequest> processInstanceVariables)
void	setState(UserTaskFilter.StateEnum state)
void	setTenantId(String tenantId)
void	setUserTaskKey(String userTaskKey)
UserTaskFilter	state(UserTaskFilter.StateEnum state)
UserTaskFilter	tenantId(String tenantId)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
UserTaskFilter	userTaskKey(String userTaskKey)

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_STATE

public static final String JSON_PROPERTY_STATE

See Also:

• Constant Field Values

JSON_PROPERTY_ASSIGNEE

public static final String JSON_PROPERTY_ASSIGNEE

See Also:

• Constant Field Values

JSON_PROPERTY_PRIORITY

public static final String JSON_PROPERTY_PRIORITY

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_ID

public static final String JSON_PROPERTY_ELEMENT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_CANDIDATE_GROUP

public static final String JSON_PROPERTY_CANDIDATE_GROUP

See Also:

• Constant Field Values

JSON_PROPERTY_CANDIDATE_USER

public static final String JSON_PROPERTY_CANDIDATE_USER

See Also:

• Constant Field Values

JSON_PROPERTY_TENANT_ID

public static final String JSON_PROPERTY_TENANT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_ID

public static final String JSON_PROPERTY_PROCESS_DEFINITION_ID

See Also:

• Constant Field Values

JSON_PROPERTY_CREATION_DATE

public static final String JSON_PROPERTY_CREATION_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_COMPLETION_DATE

public static final String JSON_PROPERTY_COMPLETION_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_FOLLOW_UP_DATE

public static final String JSON_PROPERTY_FOLLOW_UP_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_DUE_DATE

public static final String JSON_PROPERTY_DUE_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_INSTANCE_VARIABLES

public static final String JSON_PROPERTY_PROCESS_INSTANCE_VARIABLES

See Also:

• Constant Field Values

JSON_PROPERTY_LOCAL_VARIABLES

public static final String JSON_PROPERTY_LOCAL_VARIABLES

See Also:

• Constant Field Values

JSON_PROPERTY_USER_TASK_KEY

public static final String JSON_PROPERTY_USER_TASK_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_KEY

public static final String JSON_PROPERTY_PROCESS_DEFINITION_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_PROCESS_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_INSTANCE_KEY

public static final String JSON_PROPERTY_ELEMENT_INSTANCE_KEY

See Also:

• Constant Field Values

Constructor Details

UserTaskFilter

public UserTaskFilter()

Method Details

state

public UserTaskFilter state(@Nullable
 UserTaskFilter.StateEnum state)

getState

@Nullable
public UserTaskFilter.StateEnum getState()

The state of the user task.

Returns:

state

setState

public void setState(@Nullable
 UserTaskFilter.StateEnum state)

assignee

public UserTaskFilter assignee(@Nullable
 StringFilterProperty assignee)

getAssignee

@Nullable
public StringFilterProperty getAssignee()

The assignee of the user task.

Returns:

assignee

setAssignee

public void setAssignee(@Nullable
 StringFilterProperty assignee)

priority

public UserTaskFilter priority(@Nullable
 IntegerFilterProperty priority)

getPriority

@Nullable
public IntegerFilterProperty getPriority()

The priority of the user task.

Returns:

priority

setPriority

public void setPriority(@Nullable
 IntegerFilterProperty priority)

elementId

public UserTaskFilter elementId(@Nullable
 String elementId)

getElementId

@Nullable
public String getElementId()

The element ID of the user task.

Returns:

elementId

setElementId

public void setElementId(@Nullable
 String elementId)

candidateGroup

public UserTaskFilter candidateGroup(@Nullable
 StringFilterProperty candidateGroup)

getCandidateGroup

@Nullable
public StringFilterProperty getCandidateGroup()

The candidate group for this user task.

Returns:

candidateGroup

setCandidateGroup

public void setCandidateGroup(@Nullable
 StringFilterProperty candidateGroup)

candidateUser

public UserTaskFilter candidateUser(@Nullable
 StringFilterProperty candidateUser)

getCandidateUser

@Nullable
public StringFilterProperty getCandidateUser()

The candidate user for this user task.

Returns:

candidateUser

setCandidateUser

public void setCandidateUser(@Nullable
 StringFilterProperty candidateUser)

tenantId

public UserTaskFilter tenantId(@Nullable
 String tenantId)

getTenantId

@Nullable
public String getTenantId()

Tenant ID of this user task.

Returns:

tenantId

setTenantId

public void setTenantId(@Nullable
 String tenantId)

processDefinitionId

public UserTaskFilter processDefinitionId(@Nullable
 String processDefinitionId)

getProcessDefinitionId

@Nullable
public String getProcessDefinitionId()

The ID of the process definition.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nullable
 String processDefinitionId)

creationDate

public UserTaskFilter creationDate(@Nullable
 DateTimeFilterProperty creationDate)

getCreationDate

@Nullable
public DateTimeFilterProperty getCreationDate()

The user task creation date.

Returns:

creationDate

setCreationDate

public void setCreationDate(@Nullable
 DateTimeFilterProperty creationDate)

completionDate

public UserTaskFilter completionDate(@Nullable
 DateTimeFilterProperty completionDate)

getCompletionDate

@Nullable
public DateTimeFilterProperty getCompletionDate()

The user task completion date.

Returns:

completionDate

setCompletionDate

public void setCompletionDate(@Nullable
 DateTimeFilterProperty completionDate)

followUpDate

public UserTaskFilter followUpDate(@Nullable
 DateTimeFilterProperty followUpDate)

getFollowUpDate

@Nullable
public DateTimeFilterProperty getFollowUpDate()

The user task follow-up date.

Returns:

followUpDate

setFollowUpDate

public void setFollowUpDate(@Nullable
 DateTimeFilterProperty followUpDate)

dueDate

public UserTaskFilter dueDate(@Nullable
 DateTimeFilterProperty dueDate)

getDueDate

@Nullable
public DateTimeFilterProperty getDueDate()

The user task due date.

Returns:

dueDate

setDueDate

public void setDueDate(@Nullable
 DateTimeFilterProperty dueDate)

processInstanceVariables

public UserTaskFilter processInstanceVariables(@Nullable
 List<UserTaskVariableFilterRequest> processInstanceVariables)

addProcessInstanceVariablesItem

public UserTaskFilter addProcessInstanceVariablesItem(UserTaskVariableFilterRequest processInstanceVariablesItem)

getProcessInstanceVariables

@Nullable
public List<UserTaskVariableFilterRequest> getProcessInstanceVariables()

Process instance variables associated with the user task.

Returns:

processInstanceVariables

setProcessInstanceVariables

public void setProcessInstanceVariables(@Nullable
 List<UserTaskVariableFilterRequest> processInstanceVariables)

localVariables

public UserTaskFilter localVariables(@Nullable
 List<UserTaskVariableFilterRequest> localVariables)

addLocalVariablesItem

public UserTaskFilter addLocalVariablesItem(UserTaskVariableFilterRequest localVariablesItem)

getLocalVariables

@Nullable
public List<UserTaskVariableFilterRequest> getLocalVariables()

Local variables associated with the user task.

Returns:

localVariables

setLocalVariables

public void setLocalVariables(@Nullable
 List<UserTaskVariableFilterRequest> localVariables)

userTaskKey

public UserTaskFilter userTaskKey(@Nullable
 String userTaskKey)

getUserTaskKey

@Nullable
public String getUserTaskKey()

The key for this user task.

Returns:

userTaskKey

setUserTaskKey

public void setUserTaskKey(@Nullable
 String userTaskKey)

processDefinitionKey

public UserTaskFilter processDefinitionKey(@Nullable
 String processDefinitionKey)

getProcessDefinitionKey

@Nullable
public String getProcessDefinitionKey()

The key of the process definition.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(@Nullable
 String processDefinitionKey)

processInstanceKey

public UserTaskFilter processInstanceKey(@Nullable
 String processInstanceKey)

getProcessInstanceKey

@Nullable
public String getProcessInstanceKey()

The key of the process instance.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nullable
 String processInstanceKey)

elementInstanceKey

public UserTaskFilter elementInstanceKey(@Nullable
 String elementInstanceKey)

getElementInstanceKey

@Nullable
public String getElementInstanceKey()

The key of the element instance.

Returns:

elementInstanceKey

setElementInstanceKey

public void setElementInstanceKey(@Nullable
 String elementInstanceKey)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toUrlQueryString

public String toUrlQueryString()

Convert the instance into URL query string.

Returns:

URL query string

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string