oracle.fmwplatform.actionframework.api.v2.rest

Class InvokeActionReq

java.lang.Object

oracle.fmwplatform.actionframework.api.v2.rest.InvokeActionReq

public class InvokeActionReq
extends Object

REST invoke action request.

Since:

12.2.2

Constructor Summary

Constructors

Constructor and Description
InvokeActionReq() Default constructor for InvokeActionReq.
InvokeActionReq(oracle.fmwplatform.envspec.model.EnvironmentModel environmentModel) Create an InvokeActionReq initializing the pass data.
InvokeActionReq(oracle.fmwplatform.envspec.model.EnvironmentModel environmentModel, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets) Create an InvokeActionReq initializing the pass data.
InvokeActionReq(oracle.fmwplatform.envspec.model.EnvironmentModel environmentModel, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, Object extra, String oracleHome) Create an InvokeActionReq initializing the pass data.
InvokeActionReq(oracle.fmwplatform.envspec.model.EnvironmentModel environmentModel, List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets, String oracleHome) Create an InvokeActionReq initializing the pass data.

Method Summary

Modifier and Type	Method and Description
void	addAllTargets(List<? extends oracle.fmwplatform.envspec.model.targets.ModelTarget> targets) Add a collection of targets to the request.
void	addTarget(oracle.fmwplatform.envspec.model.targets.ModelTarget target) Add a new target to the request.
ActionType	getActionType() Return the type of the action to load.
oracle.fmwplatform.envspec.model.EnvironmentModel	getEnvironmentModel() Get the environment model.
Object	getExtra() Returns action extra parameters.
String	getOracleHome() Get the Oracle Home for the action.
Map<oracle.fmwplatform.envspec.common.ResourceReference,oracle.fmwplatform.envspec.common.Versioned>	getResourceReferences() Return the resource references map for this environment model.
List<oracle.fmwplatform.envspec.model.targets.ModelTarget>	getTargets() Return list of environment targets.
void	setActionType(ActionType actionType) Set the type of the action to load.
void	setEnvironmentModel(oracle.fmwplatform.envspec.model.EnvironmentModel environmentModel) Set the environment model.
void	setExtra(Object extra) Set action extra properties.
void	setOracleHome(String oracleHome) Set the Oracle Home containing the action.
InvokeActionReq	setResourceReferences(Map<oracle.fmwplatform.envspec.common.ResourceReference,oracle.fmwplatform.envspec.common.Versioned> resourceReferences) Set the map of resource references for this environment model.
void	setTargets(List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets) Set the list of targets.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InvokeActionReq

public InvokeActionReq()

Default constructor for InvokeActionReq.

InvokeActionReq

public InvokeActionReq(oracle.fmwplatform.envspec.model.EnvironmentModel environmentModel)

Create an InvokeActionReq initializing the pass data.

Parameters:

environmentModel - the environment model

InvokeActionReq

public InvokeActionReq(oracle.fmwplatform.envspec.model.EnvironmentModel environmentModel,
                       List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets)

Create an InvokeActionReq initializing the pass data.

Parameters:

environmentModel - the environment model

targets - the model targets to be applied

InvokeActionReq

public InvokeActionReq(oracle.fmwplatform.envspec.model.EnvironmentModel environmentModel,
                       List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
                       String oracleHome)

Create an InvokeActionReq initializing the pass data.

Parameters:

environmentModel - the environment model

targets - the model targets to be applied

oracleHome - the Oracle Home for the Action

InvokeActionReq

public InvokeActionReq(oracle.fmwplatform.envspec.model.EnvironmentModel environmentModel,
                       List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets,
                       Object extra,
                       String oracleHome)

Create an InvokeActionReq initializing the pass data.

Parameters:

environmentModel - the environment model

targets - the model targets to be applied

extra - any required "extra" data object for the action

oracleHome - the Oracle Home for the Action

Method Detail

getOracleHome

public String getOracleHome()

Get the Oracle Home for the action.

Returns:

the Oracle Home or null for the default OH.

setOracleHome

public void setOracleHome(String oracleHome)

Set the Oracle Home containing the action. If not set, the default Oracle home will be used.

Parameters:

oracleHome - the Oracle Home path.

getEnvironmentModel

public oracle.fmwplatform.envspec.model.EnvironmentModel getEnvironmentModel()

Get the environment model.

Returns:

environment model

setEnvironmentModel

public void setEnvironmentModel(oracle.fmwplatform.envspec.model.EnvironmentModel environmentModel)

Set the environment model.

Parameters:

environmentModel - the environment modem to be set

getTargets

public List<oracle.fmwplatform.envspec.model.targets.ModelTarget> getTargets()

Return list of environment targets.

Returns:

list of targets

setTargets

public void setTargets(List<oracle.fmwplatform.envspec.model.targets.ModelTarget> targets)

Set the list of targets.

Parameters:

targets - the action targets

addTarget

public void addTarget(oracle.fmwplatform.envspec.model.targets.ModelTarget target)

Add a new target to the request.

Parameters:

target - the target to be added

addAllTargets

public void addAllTargets(List<? extends oracle.fmwplatform.envspec.model.targets.ModelTarget> targets)

Add a collection of targets to the request.

Parameters:

targets - the targets

getExtra

public Object getExtra()

Returns action extra parameters.

Returns:

current extra parameters

setExtra

public void setExtra(Object extra)

Set action extra properties.

Parameters:

extra - the extra parameters to be set

getActionType

public ActionType getActionType()

Return the type of the action to load.

Returns:

the class name (i.e. type) or the action

setActionType

public void setActionType(ActionType actionType)

Set the type of the action to load.

Parameters:

actionType - the class name (i.e. type) or the action

getResourceReferences

public Map<oracle.fmwplatform.envspec.common.ResourceReference,oracle.fmwplatform.envspec.common.Versioned> getResourceReferences()

Return the resource references map for this environment model.

Returns:

map of resource references

setResourceReferences

public InvokeActionReq setResourceReferences(Map<oracle.fmwplatform.envspec.common.ResourceReference,oracle.fmwplatform.envspec.common.Versioned> resourceReferences)

Set the map of resource references for this environment model.

Parameters:

resourceReferences - map of resources

Returns:

this for method chaining