EndStateAction Class
- public class EndStateAction
extends Action
An action which supports marking a user as done in a campaign/scenario.
This understands the following initialization parameters:
- endState (optional): boolean as to whether to mark an end state
-
Hierarchy
-
Object
Action
EndStateAction
-
All Implemented Interfaces
-
Serializable
protected boolean |
-
endState
- Does this constitute an end state.
|
Methods from com.bea.campaign.action.Action |
getEvent , getRandom , getRequest , getScenario , getScenarioContainer , getScenarioContainerName , getScenarioId , getScenarioName , getServiceLocator , getSession , getTimestamp , getUser , locateService , setEvent , setRandom , setRequest , setScenario , setScenarioContainer , setServiceLocator , setSession , setTimestamp , setUser
|
endState
protected boolean endState
- Does this constitute an end state.
EndStateAction
public EndStateAction()
getScenarioService() Method
public ScenarioService
getScenarioService()
throws CreateException
Get the scenario service.
Exceptions
-
CreateException
- thrown on an error getting the scenario service.
getUserId() Method
public String
getUserId()
Get the user id (from the event).
-
Overrides
-
Action.getUserId()
Related Topics
ScenarioHelper.getUserId(Event)
init(Map) Method
public void init(Map
params)
throws IllegalArgumentException
Initialize this action from the action parameters.
-
Overrides
-
Action.init(Map)
Parameters
-
params
- the action parameters.
Exceptions
-
IllegalArgumentException
- thrown on invalid action parameters.
run() Method
public void run()
throws ActionException
Execute this action.
This will set an end state flag for the user for the scenario in the
scenario container.
-
Overrides
-
Action.run()
Exceptions
-
ActionException
- thrown on an error.
toString() Method
public String
toString()
-
Overrides
-
Object.toString()