oracle.fmwplatform.actionframework.api.v2

Interface Action

public interface Action

Action encapsulates the custom or standard action. The consumer calls the DefaultActionFactoryImpl to load an Action. The Action class wraps the custom or standard action hiding the implementation details of the custom or standard action. The consumer should only need to provide action name and call the methods on the Action interface in correct order. This will allow the physical implementation of the action to change without impacting the consumer of the action.

An action has an init, canInvoke, invoke and close method. Each should be called in order, and can only be called once.

Method Summary

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, Object actionObject) Initialize the action.
ActionResult	init(oracle.fmwplatform.envspec.model.EnvironmentModel model, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, Object 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, Object 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, Object actionObject, ActionMode mode) Invoke the init, canInvoke, invoke and close methods on the Action.
void	setActionClassLoader(ClassLoader classLoader) Set the classloder used by this 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, Object 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

Method Detail

init

ActionResult init(oracle.fmwplatform.envspec.model.EnvironmentModel model,
                  List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets)

Initialize the action. Sets up any resources for the action implementation. The init method must only be called once to set up the resources, and these resources are released with a close.

Parameters:

model - environment model for the action

targets - list of targets for the action

Returns:

ActionResult with the status of the custom or standard action

init

ActionResult init(oracle.fmwplatform.envspec.model.EnvironmentModel model,
                  List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
                  Object actionObject)

Initialize the action. Sets up any resources for the action implementation. The init method must only be called once to set up the resources, and these resources are released with a close.

Parameters:

model - environment model for the action

targets - list of targets for the action

actionObject - containing additional information for the action

Returns:

ActionResult with the status of the custom or standard action

init

ActionResult init(oracle.fmwplatform.envspec.model.EnvironmentModel model,
                  List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
                  ActionMode mode)

Initialize the action. Sets up any resources for the action implementation. The init method must only be called once to set up the resources, and these resources are released with a close.

Parameters:

model - environment model for the action

targets - list of targets for the action

mode - the requested mode of the action

Returns:

ActionResult with the status of the custom or standard action

init

ActionResult init(oracle.fmwplatform.envspec.model.EnvironmentModel model,
                  List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
                  Object actionObject,
                  ActionMode mode)

Initialize the action. Sets up any resources for the action implementation. The init method must only be called once to set up the resources, and these resources are released with a close.

Parameters:

model - environment model for the action

targets - list of targets for the action

actionObject - containing additional information for the action

mode - the requested mode of the action

Returns:

ActionResult with the status of the custom or standard action

canInvoke

boolean canInvoke()

This method must be called by the Action consumer before the invoke action is called.

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.

Returns:

true if the Action has been initialized and is valid

invoke

ActionResult invoke()

Invoke the custom or standard action. The action must be initialized and ready to invoke by calling the init and canInvoke method. If the action is not ready, the ActionCannotBeInvokedException will be thrown.

The invoke can only be called once on the Action.

Returns:

ActionResult with the status of the custom or standard action

close

ActionResult close()

Close the action. This will release any resources related to the action and nullify the encapsulated objects. This Action cannot be used once it is in the closed state.

Returns:

ActionResult with the status of the custom or standard action

run

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. (what should happen if the canInvoke fails? should a new status code be added to the ActionResult?)

Parameters:

model - environment model for the action

targets - list for the action

Returns:

ActionResult object with detailed results

run

ActionResult run(oracle.fmwplatform.envspec.model.EnvironmentModel model,
                 List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
                 Object actionObject)

Invoke the init, canInvoke, invoke and close methods on the Action. (what should happen if the canInvoke fails? should a new status code be added to the ActionResult?)

Parameters:

model - environment model for the action

targets - list for the action

actionObject - additional object for the action.

Returns:

ActionResult object with detailed results

run

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. (what should happen if the canInvoke fails? should a new status code be added to the ActionResult?)

Parameters:

model - environment model for the action

targets - list for the action

mode - the requested mode of the action

Returns:

ActionResult object with detailed results

run

ActionResult run(oracle.fmwplatform.envspec.model.EnvironmentModel model,
                 List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
                 Object actionObject,
                 ActionMode mode)

Invoke the init, canInvoke, invoke and close methods on the Action. (what should happen if the canInvoke fails? should a new status code be added to the ActionResult?)

Parameters:

model - environment model for the action

targets - list for the action

actionObject - additional object for the action.

mode - the requested mode of the action

Returns:

ActionResult object with detailed results

canPerformOffline

boolean canPerformOffline()

Returns true if the Action can be performed in Offline mode

Returns:

true if the Action can be performed in Offline mode

canPerformOnline

boolean canPerformOnline()

Returns true if the Action can be performed in Online mode

Returns:

true if the Action can be performed in Online mode

getName

String getName()

Return the custom or standard action name.

Returns:

name of the action

getActionClassLoader

ClassLoader getActionClassLoader()

Return the classloader being used for this Action.

Returns:

ActionClassLoader being used.

setActionClassLoader

void setActionClassLoader(ClassLoader classLoader)

Set the classloder used by this action.

Parameters:

classLoader - ActionClassLoader being used.

verify

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

Parameters:

model - environment model for the action

targets - list for the action

Returns:

true if the the action has been previously executed successfully

verify

boolean verify(oracle.fmwplatform.envspec.model.EnvironmentModel model,
               List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
               Object 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

Parameters:

model - environment model for the action

targets - list for the action

actionObject - additional object for the action.

Returns:

true if the the action has been previously executed successfully