Package com.adobe.aem.dermis.api.bridge

Class OperationOptions

java.lang.Object

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

public class OperationOptions
extends java.lang.Object

Options to be used/provided when executing an operation

Constructor Summary

Constructors

Constructor	Description
OperationOptions(java.lang.String operationId, IValueMap argumentsValueMap)	This constructor will be used in case of direct execution of operation It takes an IValueMap for operation arguments
OperationOptions(java.lang.String selectionPoints, java.util.Map<java.lang.String,java.lang.String> entityOperationMapping)	This constructor will be used in case of Read Operation
OperationOptions(java.lang.String operationId, org.apache.sling.commons.json.JSONObject arguments)	Deprecated. Use OperationOptions(String, IValueMap) instead

Method Summary

Modifier and Type	Method	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
java.lang.String	getEntityId()
java.util.Map<java.lang.String,java.lang.String>	getEntityOperationMapping()
java.lang.String	getOperationId()
boolean	getOutputTypeArray()
java.lang.String	getSchemaName()
java.lang.String	getSelectionPoints()
ValidationOptions	getValidationOptions()
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.
void	setEntityOperationMapping(java.util.Map<java.lang.String,java.lang.String> entityOperationMapping)
void	setOutputTypeArray(boolean isOutputTypeArray)
void	setSchemaName(java.lang.String name)
void	setSelectionPoints(java.lang.String selectionPoints)
void	setValidationOptions(ValidationOptions validationOptions)

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationOptions

public OperationOptions(java.lang.String selectionPoints,
                        java.util.Map<java.lang.String,java.lang.String> entityOperationMapping)

This constructor will be used in case of Read Operation

Parameters:

selectionPoints - - selection points

entityOperationMapping - - Name of the root entities and its operation id

OperationOptions

@Deprecated
public OperationOptions(java.lang.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(java.lang.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

getSelectionPoints

public java.lang.String getSelectionPoints()

Returns:

selectionPoints

setSelectionPoints

public void setSelectionPoints(java.lang.String selectionPoints)

Parameters:

selectionPoints -

getEntityOperationMapping

public java.util.Map<java.lang.String,java.lang.String> getEntityOperationMapping()

Returns:

Map of entity related operation details..

setEntityOperationMapping

public void setEntityOperationMapping(java.util.Map<java.lang.String,java.lang.String> entityOperationMapping)

Parameters:

entityOperationMapping -

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

getEntityId

public java.lang.String getEntityId()

Returns:

- identifier of entity

getOperationId

public java.lang.String getOperationId()

Returns:

- identifier of entity

setSchemaName

public void setSchemaName(java.lang.String name)

getSchemaName

public java.lang.String getSchemaName()

Returns:

- schemaName

getOutputTypeArray

public boolean getOutputTypeArray()

setOutputTypeArray

public void setOutputTypeArray(boolean isOutputTypeArray)

getValidationOptions

public ValidationOptions getValidationOptions()

setValidationOptions

public void setValidationOptions(ValidationOptions validationOptions)