|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.bea.campaign.action.Action
public abstract class Action
Base class for a campaign/scenario action.
An Action defines the behavior that will result from a rule firing in a Scenario. Actions should have the following objects set on after init()
is called, but before run()
is called:
event
: the Event
that triggered this action.random number
: the random number used during scenario execution.request
: the Request
that triggered this action.scenario
: the Scenario
this action is executed for.scenario container
: the ScenarioContainer
the scenario is part of. This should be a Campaign
.service locator
: the ServiceLocator
to use to find services.session
: the Session
that triggered this action.timestamp
: the time the event was fired.user
: the profile of the user who triggered this action.Constructor Summary | |
---|---|
Action() |
Method Summary | |
---|---|
Event |
getEvent() Get the event that initially triggered this action. |
Number |
getRandom() Get the random that was used in the scenario rules. |
Request |
getRequest() Get the request this Action is executing in. |
Scenario |
getScenario() Get the scenario that created this Action. |
ScenarioContainer |
getScenarioContainer() Get the that this action was created under. |
String |
getScenarioContainerName() Get the name of the ScenarioContainer |
String |
getScenarioId() Get the id of the scenario that created this Action |
String |
getScenarioName() Get the name of the scenario that created this Action |
ServiceLocator |
getServiceLocator() Get the ServiceLocator given to this action |
Session |
getSession() Get the session this Action is executing in. |
Timestamp |
getTimestamp() Get the timestamp of the event that caused this action. |
ProfileWrapper |
getUser() Get the user this Action is executing for. |
String |
getUserId() Get the userId associated with the event that triggered this Action |
abstract void |
init(Map params) Initialize the action with an arbitrary set of parameters. |
Object |
locateService(String name) Use this Action's ServiceLocator to lookup a service |
abstract void |
run() Run the behavior defined in the implementation of this Action. |
void |
setEvent(Event evt) Set the event that initially triggered this action This will be called by the ScenarioService prior to running the Action. |
void |
setRandom(Number n) Set the random number that was used in the scenario rules. |
void |
setRequest(Request aRequest) Set the request this Action is executing in This will be called by the ScenarioService prior to running the Action. |
void |
setScenario(Scenario s) Set the scenario that created this Action This will be called by the ScenarioService prior to running the Action. |
void |
setScenarioContainer(ScenarioContainer s) Set the ScenarioContainer that this action was created under This will be called by the ScenarioService prior to running the Action. |
void |
setServiceLocator(ServiceLocator s) Set a ServiceLocator for this Action to use. |
void |
setSession(Session aSession) Set the session this Action is executing in This will be called by the ScenarioService prior to running the Action. |
void |
setTimestamp(Timestamp s) Set the timestamp of the event that caused this action This will be called by the ScenarioService prior to running the Action. |
void |
setUser(ProfileWrapper aUser) Set the user this Action is executing for This will be called by the ScenarioService prior to running the Action. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Action()
Method Detail |
---|
public abstract void run() throws ActionException
ActionException
- will be thrown if an error occurspublic abstract void init(Map params) throws IllegalArgumentException
params
- A map of name/value pairsIllegalArgumentException
- if any required params are missingpublic void setServiceLocator(ServiceLocator s)
s
- the ServiceLocatorpublic ServiceLocator getServiceLocator()
public Object locateService(String name)
name
- the name of the servicepublic void setEvent(Event evt)
public Event getEvent()
public void setUser(ProfileWrapper aUser)
public ProfileWrapper getUser()
public String getUserId()
public void setRequest(Request aRequest)
public Request getRequest()
public void setSession(Session aSession)
public Session getSession()
public void setScenario(Scenario s)
public Scenario getScenario()
public String getScenarioName()
public String getScenarioId()
public void setScenarioContainer(ScenarioContainer s)
public ScenarioContainer getScenarioContainer()
public String getScenarioContainerName()
public void setTimestamp(Timestamp s)
public Timestamp getTimestamp()
public void setRandom(Number n)
public Number getRandom()
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.