net.pricefx.common.dto

Class WorkflowDTO.WatcherStepDTO

Object

WorkflowDTO.StepDTO

WorkflowDTO.WatcherStepDTO

Enclosing class:

WorkflowDTO

public static class WorkflowDTO.WatcherStepDTO
extends WorkflowDTO.StepDTO

Field Summary

Fields inherited from class WorkflowDTO.StepDTO

emailAttachment, properties, uniqueName, workflow

Constructor Summary

Constructors

Constructor and Description
WatcherStepDTO(WorkflowDTO workflow, String userLoginName)

Method Summary

Modifier and Type	Method and Description
WorkflowDTO.WatcherStepDTO	addProperty(String name, Object value)
void	fromMap(Map<String,Object> values)
String[]	getEmailListWatcher() Gets the list of email addresses if specified as recipient for this node
String	getReason() Returns the reason text
String	getUserGroupWatcher() Gets user group name in case of group watcher (or null otherwise)
String	getUserWatcher() Return the current watcher (or null if none set or if group watcher)
WorkflowDTO.WatcherStepDTO	setReason(String reason)
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 #withUserWatcher(String), #withUserGroupWatcher(String), #withEmailListWatcher(String...) wins
WorkflowDTO.WatcherStepDTO	withUserGroupWatcher(String userGroupUniqueName) Specify a user group as recipient Last invoked of #withUserWatcher(String), #withUserGroupWatcher(String), #withEmailListWatcher(String...) wins
WorkflowDTO.WatcherStepDTO	withUserWatcher(String userLoginName) Specify a user as recipient Last invoked of #withUserWatcher(String), #withUserGroupWatcher(String), #withEmailListWatcher(String...) wins

Methods inherited from class WorkflowDTO.StepDTO

equals, getEmailAttachment, getProperties, getUniqueName, hashCode, withEmailAttachment, withEmailAttachment

Methods inherited from class Object

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

Constructor Detail

WatcherStepDTO

public WatcherStepDTO(WorkflowDTO workflow,
                      String userLoginName)

Method Detail

withUserWatcher

public WorkflowDTO.WatcherStepDTO withUserWatcher(String userLoginName)

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

withUserGroupWatcher

public WorkflowDTO.WatcherStepDTO withUserGroupWatcher(String userGroupUniqueName)

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

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 #withUserWatcher(String), #withUserGroupWatcher(String), #withEmailListWatcher(String...) wins

addProperty

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

setReason

public WorkflowDTO.WatcherStepDTO setReason(String reason)

getUserWatcher

public String getUserWatcher()

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

Returns:

The user name

getReason

public String getReason()

Returns the reason text

Returns:

The reason

getUserGroupWatcher

public String getUserGroupWatcher()

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

Returns:

getEmailListWatcher

public String[] getEmailListWatcher()

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

Returns:

toMap

public Map<String,Object> toMap()

Overrides:

toMap in class WorkflowDTO.StepDTO

fromMap

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

Overrides:

fromMap in class WorkflowDTO.StepDTO