Package net.pricefx.common.dto

Class WorkflowDTO.WatcherStepDTO

Object

WorkflowDTO.StepDTO<WorkflowDTO.WatcherStepDTO>

WatcherStepDTO

Enclosing class:

WorkflowDTO

public static class WorkflowDTO.WatcherStepDTO
extends WorkflowDTO.StepDTO<WorkflowDTO.WatcherStepDTO>

A watcher step of the workflow: its recipients are notified by email when the step becomes active, but they cannot approve or deny. Returned by WorkflowDTO.addWatcherStep(String).

The recipients are users, user groups or email addresses; the last of these set wins.

Example:

 workflow.addWatcherStep("Review")
   .withUserGroupWatchers("Managers")
   .withReasons("Status update")
 

See Also:

• Workflow Notifications

Field Summary

Fields inherited from class WorkflowDTO.StepDTO

alreadySatisfiedComment, emailAttachment, emailAttachmentTemplateName, properties, uniqueName, workflow

Constructor Summary

Constructors

Constructor	Description
WatcherStepDTO(WorkflowDTO workflow, String userLoginName)

Method Summary

Modifier and Type	Method	Description
WorkflowDTO.WatcherStepDTO	addProperty(String name, Object value)	Adds a custom property to the step.
void	fromMap(Map<String,Object> values)
String[]	getEmailListWatcher()	Gets the list of email addresses if specified as recipient for this node
String	getReason()	Deprecated. Use getReasons() instead.
List<String>	getReasons()	Returns the reason text
String	getUserGroupWatcher()	Deprecated. Use getUserGroupWatchers() instead.
List<String>	getUserGroupWatchers()	Gets user group names in case of group watchers (or null otherwise)
String	getUserWatcher()	Deprecated. Use getUserWatchers() instead.
List<String>	getUserWatchers()	Return the current watchers (or null if none set or if group watchers)
WorkflowDTO.WatcherStepDTO	setReason(String reason)	Sets one explanation reason for the watcher step.
WorkflowDTO.WatcherStepDTO	setReason(List<String> reasons)	Sets explanation reasons for the watcher step, one for each watcher.
Map<String,Object>	toMap()
WorkflowDTO.WatcherStepDTO	withEmailListWatcher(String... emails)	Instead of specifying a user name or a user group, arbitrary email addresses can be used here Last invoked of withUserWatchers(String...), withUserGroupWatchers(String...), withEmailListWatcher(String...) wins
WorkflowDTO.WatcherStepDTO	withReasons(String... reasons)	Sets explanations for the watcher step.
WorkflowDTO.WatcherStepDTO	withUserGroupWatcher(String userGroupUniqueName)	Deprecated. Use withUserGroupWatchers(String...) instead.
WorkflowDTO.WatcherStepDTO	withUserGroupWatchers(String... userGroupUniqueNames)	Specify user groups as recipient Last invoked of withUserWatchers(String...), withUserGroupWatchers(String...), withEmailListWatcher(String...) wins
WorkflowDTO.WatcherStepDTO	withUserWatcher(String userLoginName)	Deprecated. Use withUserWatchers(String...) instead.
WorkflowDTO.WatcherStepDTO	withUserWatchers(String... userLoginNames)	Specify users as recipients Last invoked of withUserWatchers(String...), withUserGroupWatchers(String...), withEmailListWatcher(String...) wins

Methods inherited from class WorkflowDTO.StepDTO

equals, getAlreadySatisfiedComment, getEmailAttachment, getEmailAttachmentTemplateName, getProperties, getUniqueName, hashCode, readSingleValue, withAlreadySatisfied, withAlreadySatisfied, withEmailAttachment, withEmailAttachment, withEmailAttachmentTemplateName

Methods inherited from class Object

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

Constructor Details

WatcherStepDTO

public WatcherStepDTO(WorkflowDTO workflow,
 String userLoginName)

Method Details

withUserWatcher

@Deprecated
public WorkflowDTO.WatcherStepDTO withUserWatcher(String userLoginName)

Deprecated.

Use withUserWatchers(String...) instead.

Specify a user as recipient Last invoked of withUserWatcher(String), withUserGroupWatcher(String), withEmailListWatcher(String...) wins

Parameters:

userLoginName - The login name of the watcher

Returns:

The watcher step itself.

withUserWatchers

public WorkflowDTO.WatcherStepDTO withUserWatchers(String... userLoginNames)

Specify users as recipients Last invoked of withUserWatchers(String...), withUserGroupWatchers(String...), withEmailListWatcher(String...) wins

Example:

 workflow.addWatcherStep("Info").withUserWatchers("mary", "bob")
 

Parameters:

userLoginNames - The login names of the watchers

Returns:

The watcher step itself.

See Also:

• withUserGroupWatchers(String...)
• withEmailListWatcher(String...)

withUserGroupWatcher

@Deprecated
public WorkflowDTO.WatcherStepDTO withUserGroupWatcher(String userGroupUniqueName)

Deprecated.

Use withUserGroupWatchers(String...) instead.

Specify user group as recipient Last invoked of withUserWatcher(String), withUserGroupWatcher(String), withEmailListWatcher(String...) wins

Parameters:

userGroupUniqueName - The unique name of the watching user group

Returns:

The watcher step itself.

withUserGroupWatchers

public WorkflowDTO.WatcherStepDTO withUserGroupWatchers(String... userGroupUniqueNames)

Specify user groups as recipient Last invoked of withUserWatchers(String...), withUserGroupWatchers(String...), withEmailListWatcher(String...) wins

Example:

 workflow.addWatcherStep("Review").withUserGroupWatchers("Managers")
 

Parameters:

userGroupUniqueNames - The unique names of the watching user groups

Returns:

The watcher step itself.

See Also:

• withUserWatchers(String...)
• withEmailListWatcher(String...)

withEmailListWatcher

public WorkflowDTO.WatcherStepDTO withEmailListWatcher(String... emails)

Instead of specifying a user name or a user group, arbitrary email addresses can be used here Last invoked of withUserWatchers(String...), withUserGroupWatchers(String...), withEmailListWatcher(String...) wins

Invalid email addresses make the workflow fail with an error that lists them.

Example:

 workflow.addWatcherStep("Customer Service").withEmailListWatcher("cs@example.com")
 

Parameters:

emails - The email addresses of the recipients

Returns:

The watcher step itself.

See Also:

• withUserWatchers(String...)
• withUserGroupWatchers(String...)

addProperty

public WorkflowDTO.WatcherStepDTO addProperty(String name,
 Object value)

Adds a custom property to the step. The properties are stored with the workflow step.

Parameters:

name - The property name

value - The property value

Returns:

The watcher step itself.

See Also:

• WorkflowDTO.StepDTO.getProperties()

setReason

public WorkflowDTO.WatcherStepDTO setReason(String reason)

Sets one explanation reason for the watcher step.

Parameters:

reason - The reason as a String

Returns:

The watcher step itself.

See Also:

• withReasons(String...)

setReason

public WorkflowDTO.WatcherStepDTO setReason(List<String> reasons)

Sets explanation reasons for the watcher step, one for each watcher.

Parameters:

reasons - The reasons as a List of String, matched to the watchers by position

Returns:

The watcher step itself.

See Also:

• withReasons(String...)

withReasons

public WorkflowDTO.WatcherStepDTO withReasons(String... reasons)

Sets explanations for the watcher step.

Example:

 workflow.addWatcherStep("Review")
   .withUserWatchers("w1", "w2")
   .withReasons("Margin below target", "FYI")
 

Parameters:

reasons - The reasons why each watcher is notified. The reasons match watchers. E.g. if you have 3 watchers (w1, w2, w3), you can specify up to 3 reasons (r1, r2, r3) and then r1 corresponds to w1, r2 to w2 etc. If you want to put multiple reasons to a single watcher, you need to join the strings and return a single combined reason in the code.

Returns:

The watcher step itself.

See Also:

• getReasons()

getUserWatcher

@Deprecated
public String getUserWatcher()

Deprecated.

Use getUserWatchers() instead.

Return the current watcher (or null if none set or if group watcher)

Returns:

The user name

getUserWatchers

public List<String> getUserWatchers()

Return the current watchers (or null if none set or if group watchers)

Returns:

The user names

See Also:

• withUserWatchers(String...)

getReason

@Deprecated
public String getReason()

Deprecated.

Use getReasons() instead.

Returns the reason text

Returns:

The reason

getReasons

public List<String> getReasons()

Returns the reason text

Returns:

The reason

See Also:

• withReasons(String...)

getUserGroupWatcher

@Deprecated
public String getUserGroupWatcher()

Deprecated.

Use getUserGroupWatchers() instead.

Gets user group name in case of group watcher (or null otherwise)

Returns:

The user group unique name as a String, or null

getUserGroupWatchers

public List<String> getUserGroupWatchers()

Gets user group names in case of group watchers (or null otherwise)

Returns:

The user group unique names as a List of String, or null

See Also:

• withUserGroupWatchers(String...)

getEmailListWatcher

public String[] getEmailListWatcher()

Gets the list of email addresses if specified as recipient for this node

Returns:

The email addresses as a String array, or null if none were specified

See Also:

• withEmailListWatcher(String...)

toMap

public Map<String,Object> toMap()

Overrides:

toMap in class WorkflowDTO.StepDTO<WorkflowDTO.WatcherStepDTO>

fromMap

public void fromMap(Map<String,Object> values)

Overrides:

fromMap in class WorkflowDTO.StepDTO<WorkflowDTO.WatcherStepDTO>