Class ChangeWorkflowDefinitionRequest.Builder
Object
Builder
- Enclosing class:
ChangeWorkflowDefinitionRequest
-
Method Summary
Modifier and TypeMethodDescriptionaddConfigurationVariable(String configurationVariableKey, String configurationVariableValue) Adds configuration variable.addReassignRoleId(UUID reassignRoleId) Adds a reassign role ID that identifies the role that allow to reassign the workflow.addStartEvent(WorkflowStartEventType startEvent) Adds a workflow start event.addStartRoleId(UUID startRoleId) Adds a start role ID that identifies the role that allow to start the workflow.addStopRoleId(UUID stopRoleId) Adds a stop role ID that identifies the role that allow to stop the workflow.build()businessItemResourceType(WorkflowBusinessItemType businessItemResourceType) The type of the business item corresponding to the workflow.but()Deprecated.This method will be removed in the future.candidateUserCheckDisabled(Boolean candidateUserCheckDisabled) Deprecated.candidateUserCheckEnabled(Boolean candidateUserCheckEnabled) Whether the candidate user check for the workflow should be enabled.configurationVariables(Map<String, String> configurationVariables) The configuration variables.description(String description) The new description for the workflow definition.Whether the workflow definition should be enabled.exclusivity(WorkflowExclusivity exclusivity) Defines the number of times a resource workflow is able to be start (seeWorkflowExclusivity).globalCreate(Boolean globalCreate) Whether the workflow is accessible from the global create menu.guestUserAccessible(Boolean guestUserAccessible) Whether the workflow should be accessible by the guest userRequired. The ID of the workflow definition.The name of the workflow definition.reassignRoleIds(List<UUID> reassignRoleIds) The list of IDs identifying the roles allowing to reassign the workflow.registeredUserAccessible(Boolean registeredUserAccessible) Whether the workflow should be accessible by the registered user.startEvents(List<WorkflowStartEventType> startEvents) The list of workflow start event types.startLabel(String startLabel) The start label of the workflow.startRoleIds(List<UUID> startRoleIds) The list of IDs identifying the roles allowing to start the workflow.stopRoleIds(List<UUID> stopRoleIds) The list of IDs identifying the roles allowing to stop the workflow.toString()
-
Method Details
-
addConfigurationVariable
public ChangeWorkflowDefinitionRequest.Builder addConfigurationVariable(String configurationVariableKey, String configurationVariableValue) Adds configuration variable.- Parameters:
configurationVariableKey- the configuration variable keyconfigurationVariableValue- the configuration variable value
-
addStartEvent
Adds a workflow start event.- Parameters:
startEvent- a workflow start event
-
addStartRoleId
Adds a start role ID that identifies the role that allow to start the workflow.- Parameters:
startRoleId- a start role ID.
-
addStopRoleId
Adds a stop role ID that identifies the role that allow to stop the workflow.- Parameters:
stopRoleId- a stop role ID.
-
addReassignRoleId
Adds a reassign role ID that identifies the role that allow to reassign the workflow.- Parameters:
reassignRoleId- a reassign role ID.
-
but
Deprecated.This method will be removed in the future. Please, useChangeWorkflowDefinitionRequest.builder()Clone method for this Builder. -
id
Required. The ID of the workflow definition. Silently ignored if the ID is provided as path parameter of the request.- Returns:
this.
-
name
The name of the workflow definition.- Returns:
this.
-
description
The new description for the workflow definition.- Returns:
this.
-
configurationVariables
public ChangeWorkflowDefinitionRequest.Builder configurationVariables(Map<String, String> configurationVariables) The configuration variables.- Returns:
this.
-
startEvents
public ChangeWorkflowDefinitionRequest.Builder startEvents(List<WorkflowStartEventType> startEvents) The list of workflow start event types.- Returns:
this.
-
businessItemResourceType
public ChangeWorkflowDefinitionRequest.Builder businessItemResourceType(WorkflowBusinessItemType businessItemResourceType) The type of the business item corresponding to the workflow.- Returns:
this.
-
exclusivity
Defines the number of times a resource workflow is able to be start (seeWorkflowExclusivity).- Returns:
this.
-
guestUserAccessible
Whether the workflow should be accessible by the guest user- Returns:
this.
-
registeredUserAccessible
public ChangeWorkflowDefinitionRequest.Builder registeredUserAccessible(Boolean registeredUserAccessible) Whether the workflow should be accessible by the registered user.- Returns:
this.
-
candidateUserCheckDisabled
@Deprecated public ChangeWorkflowDefinitionRequest.Builder candidateUserCheckDisabled(Boolean candidateUserCheckDisabled) Deprecated.Whether the candidate user check for the workflow should be disabled.- Returns:
this.
-
candidateUserCheckEnabled
public ChangeWorkflowDefinitionRequest.Builder candidateUserCheckEnabled(Boolean candidateUserCheckEnabled) Whether the candidate user check for the workflow should be enabled.- Returns:
this.
-
globalCreate
Whether the workflow is accessible from the global create menu.- Returns:
this.
-
enable
Whether the workflow definition should be enabled.- Returns:
this.
-
startLabel
The start label of the workflow.- Returns:
this.
-
startRoleIds
The list of IDs identifying the roles allowing to start the workflow.- Returns:
this.
-
stopRoleIds
The list of IDs identifying the roles allowing to stop the workflow.- Returns:
this.
-
reassignRoleIds
The list of IDs identifying the roles allowing to reassign the workflow.- Returns:
this.
-
build
-
toString
-