public interface Action
An action has an init, canInvoke, invoke and close method. Each should be called in order, and can only be called once.
Modifier and Type | Method and Description |
---|---|
boolean |
canInvoke()
This method must be called by the Action consumer before the invoke action
is called.
|
boolean |
canPerformOffline()
Returns true if the Action can be performed in Offline mode
|
boolean |
canPerformOnline()
Returns true if the Action can be performed in Online mode
|
ActionResult |
close()
Close the action.
|
ClassLoader |
getActionClassLoader()
Return the classloader being used for this Action.
|
String |
getName()
Return the custom or standard action name.
|
ActionResult |
init(oracle.fmwplatform.envspec.model.EnvironmentModel model,
List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets)
Initialize the action.
|
ActionResult |
init(oracle.fmwplatform.envspec.model.EnvironmentModel model,
List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
ActionMode mode)
Initialize the action.
|
ActionResult |
init(oracle.fmwplatform.envspec.model.EnvironmentModel model,
List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
Properties actionObject)
Initialize the action.
|
ActionResult |
init(oracle.fmwplatform.envspec.model.EnvironmentModel model,
List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
Properties actionObject,
ActionMode mode)
Initialize the action.
|
ActionResult |
invoke()
Invoke the custom or standard action.
|
ActionResult |
run(oracle.fmwplatform.envspec.model.EnvironmentModel model,
List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets)
Invoke the init, canInvoke, invoke and close methods on the Action.
|
ActionResult |
run(oracle.fmwplatform.envspec.model.EnvironmentModel model,
List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
ActionMode mode)
Invoke the init, canInvoke, invoke and close methods on the Action.
|
ActionResult |
run(oracle.fmwplatform.envspec.model.EnvironmentModel model,
List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
Properties actionObject)
Invoke the init, canInvoke, invoke and close methods on the Action.
|
ActionResult |
run(oracle.fmwplatform.envspec.model.EnvironmentModel model,
List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
Properties actionObject,
ActionMode mode)
Invoke the init, canInvoke, invoke and close methods on the Action.
|
boolean |
verify(oracle.fmwplatform.envspec.model.EnvironmentModel model,
List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets)
In this method, action authors must implement logic to determine if the environment is in a state
which is consistent with the action having previously been executed successfully
|
boolean |
verify(oracle.fmwplatform.envspec.model.EnvironmentModel model,
List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
Properties actionObject)
In this method, action authors must implement logic to determine if the environment is in a state
which is consistent with the action having previously been executed successfully
|
ActionResult init(oracle.fmwplatform.envspec.model.EnvironmentModel model, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets)
model
- environment model for the actiontargets
- list of targets for the actionActionResult init(oracle.fmwplatform.envspec.model.EnvironmentModel model, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, Properties actionObject)
model
- environment model for the actiontargets
- list of targets for the actionactionObject
- containing additional information for the actionActionResult init(oracle.fmwplatform.envspec.model.EnvironmentModel model, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, ActionMode mode)
model
- environment model for the actiontargets
- list of targets for the actionmode
- the requested mode of the actionActionResult init(oracle.fmwplatform.envspec.model.EnvironmentModel model, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, Properties actionObject, ActionMode mode)
model
- environment model for the actiontargets
- list of targets for the actionactionObject
- containing additional information for the actionmode
- the requested mode of the actionboolean canInvoke()
This Action must be in the initialized state before calling the canInvoke. The action will validate that the action is ready to be invoked. The canInvoke can only be called once.
ActionResult invoke()
The invoke can only be called once on the Action.
ActionResult close()
ActionResult run(oracle.fmwplatform.envspec.model.EnvironmentModel model, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets)
model
- environment model for the actiontargets
- list for the actionActionResult
object with detailed resultsActionResult run(oracle.fmwplatform.envspec.model.EnvironmentModel model, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, Properties actionObject)
model
- environment model for the actiontargets
- list for the actionactionObject
- additional object for the action.ActionResult
object with detailed resultsActionResult run(oracle.fmwplatform.envspec.model.EnvironmentModel model, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, ActionMode mode)
model
- environment model for the actiontargets
- list for the actionmode
- the requested mode of the actionActionResult
object with detailed resultsActionResult run(oracle.fmwplatform.envspec.model.EnvironmentModel model, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, Properties actionObject, ActionMode mode)
model
- environment model for the actiontargets
- list for the actionactionObject
- additional object for the action.mode
- the requested mode of the actionActionResult
object with detailed resultsboolean canPerformOffline()
boolean canPerformOnline()
String getName()
ClassLoader getActionClassLoader()
boolean verify(oracle.fmwplatform.envspec.model.EnvironmentModel model, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets)
model
- environment model for the actiontargets
- list for the actionboolean verify(oracle.fmwplatform.envspec.model.EnvironmentModel model, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, Properties actionObject)
model
- environment model for the actiontargets
- list for the actionactionObject
- additional object for the action.