com.adobe.aem.dermis.api.bridge

Class OperationOptions

java.lang.Object

com.adobe.aem.dermis.api.bridge.OperationOptions

public class OperationOptions
extends Object

Options to be used/provided when executing an operation

Constructor Summary

Constructors

Constructor and Description
OperationOptions(String operationId, IValueMap argumentsValueMap) This constructor will be used in case of direct execution of operation It takes an IValueMap for operation arguments
OperationOptions(String operationId, org.apache.sling.commons.json.JSONObject arguments) Deprecated. Use OperationOptions(String, IValueMap) instead

Method Summary

Modifier and Type	Method and Description
org.apache.sling.commons.json.JSONObject	getArguments() Deprecated. Use getArgumentsValueMap() instead
IValueMap	getArgumentsValueMap() Get arguments (in IValueMap format) representing the input of the operation
void	setArguments(org.apache.sling.commons.json.JSONObject arguments) Deprecated. Use setArgumentsValueMap(IValueMap) instead
void	setArgumentsValueMap(IValueMap arguments) Set input of the operation Input arguments can be given either as a JSONObject or as IValueMap - these two formats are mutually exclusive.

Constructor Detail

OperationOptions

@Deprecated
public OperationOptions(String operationId,
                                    org.apache.sling.commons.json.JSONObject arguments)

Deprecated. Use OperationOptions(String, IValueMap) instead

This constructor will be used in case of direct execution of operation It takes a JSONObject for operation arguments

Parameters:

operationId - - name of operation

arguments - - input of the operation

OperationOptions

public OperationOptions(String operationId,
                        IValueMap argumentsValueMap)

This constructor will be used in case of direct execution of operation It takes an IValueMap for operation arguments

Parameters:

operationId -

argumentsValueMap -

Method Detail

getArguments

@Deprecated
public org.apache.sling.commons.json.JSONObject getArguments()

Deprecated. Use getArgumentsValueMap() instead

Get arguments representing the input of the operation

Returns:

input in JSONObject format

getArgumentsValueMap

public IValueMap getArgumentsValueMap()

Get arguments (in IValueMap format) representing the input of the operation

Returns:

input in JSONObject format

setArguments

@Deprecated
public void setArguments(org.apache.sling.commons.json.JSONObject arguments)

Deprecated. Use setArgumentsValueMap(IValueMap) instead

Set input of the operation (as JSONObject). Input arguments can be given either as a JSONObject or as IValueMap - these two formats are mutually exclusive. If input arguments have been provided in one format, it should not be provided in another format, unless the already provided inputs are cleared

Parameters:

arguments - input in JSONObject format

setArgumentsValueMap

public void setArgumentsValueMap(IValueMap arguments)

Set input of the operation Input arguments can be given either as a JSONObject or as IValueMap - these two formats are mutually exclusive. If input arguments have been provided in one format, it should not be provided in another format, unless the already provided inputs are cleared

Parameters:

arguments - input in JSONObject format