com.adobe.aem.dermis.api.bridge

Class Query

java.lang.Object

com.adobe.aem.dermis.api.bridge.Query

public class Query
extends Object

This represents a query object that is used to execute a operation in dermis.

Constructor Summary

Constructors

Constructor and Description
Query(String formDataModelPath, DataContext dataContext) Create Query using form data model path and data context
Query(String formDataModelPath, DataContext dataContext, OperationOptions options) Create Query using form data model path, data context and operation arguments

Method Summary

Modifier and Type	Method and Description
org.apache.sling.commons.json.JSONObject	getArguments() Deprecated. Use getArgumentsValueMap() instead
IValueMap	getArgumentsValueMap() Get arguments representing the input of the operation as IValueMap
DataContext	getDataContext() Gets DataContext represents a pluggable mechanism for resolving a operation arguments at evaluation time.
String	getFormDataModelPath() Get FormDataModel unique identifier
OperationOptions	getOptions() Get OperationOptions which provide additional option of query
boolean	getOutputTypeArray() Tells whether return type of this operation is an array or not
boolean	isEvaluateComputedAttrs()
void	setArguments(org.apache.sling.commons.json.JSONObject arguments) Deprecated. Use setArgumentsValueMap(IValueMap) instead
void	setArgumentsValueMap(IValueMap arguments) Set operation arguments, accepts an IValueMap for arguments Input arguments can be given either as a JSONObject or as IValueMap - these two formats are mutually exclusive.
void	setDataContext(DataContext dataContext) Sets the dataContext which will be used for resolving a operation arguments at evaluation time.
void	setEvaluateComputedAttrs(boolean evaluateComputedAttrs)
void	setFormDataModelPath(String formDataModelPath) Sets the formDataModel unique identifier.
void	setOptions(OperationOptions options) Set OperationOptions in query
void	setOutputTypeArray(boolean isOutputTypeArray) Sets whether return type of this operation is an array or not

Constructor Detail

Query

public Query(String formDataModelPath,
             DataContext dataContext)

Create Query using form data model path and data context

Parameters:

formDataModelPath -

dataContext -

Query

public Query(String formDataModelPath,
             DataContext dataContext,
             OperationOptions options)

Create Query using form data model path, data context and operation arguments

Parameters:

formDataModelPath -

dataContext -

options -

Method Detail

getDataContext

public DataContext getDataContext()

Gets DataContext represents a pluggable mechanism for resolving a operation arguments at evaluation time.

Returns:

- DataContext

setDataContext

public void setDataContext(DataContext dataContext)

Sets the dataContext which will be used for resolving a operation arguments at evaluation time.

Parameters:

dataContext - DataContext

getFormDataModelPath

public String getFormDataModelPath()

Get FormDataModel unique identifier

Returns:

identifier of FormDataModel

setFormDataModelPath

public void setFormDataModelPath(String formDataModelPath)

Sets the formDataModel unique identifier.

Parameters:

formDataModelPath - - unique identifier of FormDataModel

getOptions

public OperationOptions getOptions()

Get OperationOptions which provide additional option of query

Returns:

OperationOptions

setOptions

public void setOptions(OperationOptions options)

Set OperationOptions in query

Parameters:

options - OperationOptions

setArguments

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

Deprecated. Use setArgumentsValueMap(IValueMap) instead

Set operation arguments, accepts a JSONObject for arguments 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 -

setArgumentsValueMap

public void setArgumentsValueMap(IValueMap arguments)

Set operation arguments, accepts an IValueMap for arguments 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 -

getArguments

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

Deprecated. Use getArgumentsValueMap() instead

Get arguments representing the input of the operation as JSONObject

Returns:

input in JSONObject format

getArgumentsValueMap

public IValueMap getArgumentsValueMap()

Get arguments representing the input of the operation as IValueMap

Returns:

input in IValueMap format

getOutputTypeArray

public boolean getOutputTypeArray()

Tells whether return type of this operation is an array or not

Returns:

setOutputTypeArray

public void setOutputTypeArray(boolean isOutputTypeArray)

Sets whether return type of this operation is an array or not

isEvaluateComputedAttrs

public boolean isEvaluateComputedAttrs()

setEvaluateComputedAttrs

public void setEvaluateComputedAttrs(boolean evaluateComputedAttrs)