EndStateAction Class

com.bea.campaign
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:


Hierarchy
Object
  Action
    EndStateAction
All Implemented Interfaces

Serializable

Field Summary

protected boolean
endState
Does this constitute an end state.
 

Constructor Summary

EndStateAction()

 

Method Summary

public ScenarioService
getScenarioService()
Get the scenario service.
public String
getUserId()
Get the user id (from the event).
public void
init(Map params)
Initialize this action from the action parameters.
public void
run()
Execute this action.
public String
toString()
 
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
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
   

Field Detail

endState

protected boolean endState
Does this constitute an end state.

 

Constructor Detail

EndStateAction

public EndStateAction()
 

Method Detail

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()