Class CreationWorkflowStepDefinition
Object
CreationWorkflowStepDefinition
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetLabel()
Retrieves the label of the Creation Workflow step (theCreationWorkflowStepDefinition
object).boolean
Returns the value of theshouldSendNotification
field.Deprecated.Retrieves users assigned (userAssignees) to the Creation Workflow Step.Deprecated.Retrieves user groups assigned to the Creation Workflow Step.Retrieves watcher user groups (userGroupWatchers) from the Creation Workflow Step.Retrieves watchers (userWatchers) from the Creation Workflow Step.Sets the label of the Creation Workflow step (theCreationWorkflowStepDefinition
object).
Example:withShouldSendNotification
(boolean shouldSendNotification) Set tofalse
to not send the notification to users when the document with assigned users or user groups is created.
Default:true
withUserAssignee
(String userAssigneeLoginName) Assigns a user to the Creation Workflow Step.withUserAssignees
(String... userAssigneeLoginName) Assigns one or more users to the Creation Workflow Step.withUserGroupAssignee
(String userGroupAssigneeUniqueName) Assigns a user group to the Creation Workflow Step.withUserGroupAssignees
(String... userGroupAssigneeUniqueNames) Assigns one or more user groups to the Creation Workflow Step.withUserGroupWatchers
(String... userGroupWatcherUniqueNames) Assigns user group(s) as watchers to the Creation Workflow Step.
Example:withUserWatchers
(String... userWatcherLoginNames) Adds users as watchers to the Creation Workflow Step.
Example:
-
Constructor Details
-
CreationWorkflowStepDefinition
public CreationWorkflowStepDefinition()
-
-
Method Details
-
getLabel
Retrieves the label of the Creation Workflow step (theCreationWorkflowStepDefinition
object).- Returns:
- The label of the given Creation Workflow step.
- Since:
- 3.4.0 - Cuba Libre
- See Also:
-
withLabel
Sets the label of the Creation Workflow step (theCreationWorkflowStepDefinition
object).
Example:def step1 = api.newCreationWorkflowStep() .withLabel("The Step One") .withUserAssignees("admin", "john.price")
- Parameters:
label
- The label as a string.- Returns:
- The
CreationWorkflowStepDefinition
object with the given label. - Since:
- 3.4.0 - Cuba Libre
- See Also:
-
getUserAssignee
Deprecated. -
getUserAssignees
Retrieves users assigned (userAssignees) to the Creation Workflow Step.- Returns:
- userAssignees from the
CreationWorkflowStepDefinition
object. - Since:
- 3.5.2 - Salty Dog PR2
- See Also:
-
withUserAssignee
Assigns a user to the Creation Workflow Step.- Parameters:
userAssigneeLoginName
- The login name of the user you want to assign to the Creation Workflow Step.- Returns:
- The
CreationWorkflowStepDefinition
object with the specifieduserAssignee
. - Since:
- 3.4.0 - Cuba Libre
- See Also:
-
withUserAssignees
Assigns one or more users to the Creation Workflow Step.- Parameters:
userAssigneeLoginName
- The login name(s) of the user(s) you want to assign to the Creation Workflow Step.- Returns:
- The
CreationWorkflowStepDefinition
object containing specifieduserAssignees
as a list. - Since:
- 3.5.2 - Salty Dog PR2
- See Also:
-
withUserWatchers
Adds users as watchers to the Creation Workflow Step.
Example:def step1 = api.newCreationWorkflowStep() .withLabel("The Step One") .withUserAssignees("admin", "john.price") .withUserWatchers("john.doe", "anna.broke")
- Parameters:
userWatcherLoginNames
- The login name(s) of the user(s) you want to assign as watchers to the Creation Workflow Step.- Returns:
- The
CreationWorkflowStepDefinition
object containing specifieduserWatchers
as a list. - Since:
- 3.6.0 - El Presidente
- See Also:
-
withUserGroupWatchers
Assigns user group(s) as watchers to the Creation Workflow Step.
Example:def step1 = api.newCreationWorkflowStep() .withLabel("The Step One") .withUserAssignees("admin", "john.price") .withUserGroupWatchers("Pricing Managers", "Marketing")
- Parameters:
userGroupWatcherUniqueNames
- The unique name(s) of the user group(s) you want to assign as watchers to the Creation Workflow Step.- Returns:
- The
CreationWorkflowStepDefinition
object containing specifieduserGroupWatchers
as a list. - Since:
- 3.6.0 - El Presidente
- See Also:
-
getUserWatchers
Retrieves watchers (userWatchers) from the Creation Workflow Step.- Returns:
- userWatchers from the
CreationWorkflowStepDefinition
object. - Since:
- 3.6.0 - El Presidente
- See Also:
-
getUserGroupWatchers
Retrieves watcher user groups (userGroupWatchers) from the Creation Workflow Step.- Returns:
- userGroupWatchers unique names from the
CreationWorkflowStepDefinition
object as a list. - Since:
- 3.6.0 - El Presidente
- See Also:
-
getUserGroupAssignee
Deprecated. -
getUserGroupAssignees
Retrieves user groups assigned to the Creation Workflow Step.- Returns:
- userGroupAssignees unique names from the
CreationWorkflowStepDefinition
object as a list. - See Also:
-
withUserGroupAssignee
Assigns a user group to the Creation Workflow Step.- Parameters:
userGroupAssigneeUniqueName
- The unique name of the user group you want to assign to the Creation Workflow Step.- Returns:
- The
CreationWorkflowStepDefinition
object including the specifieduserGroupAssignee
. - Since:
- 3.5.2 - Salty Dog PR2
- See Also:
-
withUserGroupAssignees
public CreationWorkflowStepDefinition withUserGroupAssignees(String... userGroupAssigneeUniqueNames) Assigns one or more user groups to the Creation Workflow Step.- Parameters:
userGroupAssigneeUniqueNames
- A list of user group unique names you want to assign to the Creation Workflow Step.- Returns:
- The
CreationWorkflowStepDefinition
object including the specifieduserGroupAssignees
. - Since:
- 3.4.0 - Cuba Libre
- See Also:
-
getShouldSendNotification
public boolean getShouldSendNotification()Returns the value of theshouldSendNotification
field.- Returns:
- true, or false
- Since:
- 3.4.0 - Cuba Libre
- See Also:
-
withShouldSendNotification
Set tofalse
to not send the notification to users when the document with assigned users or user groups is created.
Default:true
- Parameters:
shouldSendNotification
- true (default), or false.- Returns:
- The
CreationWorkflowStepDefinition
object withshouldSendNotification
boolean value set as specified. - Since:
- 3.4.0 - Cuba Libre
- See Also:
-