Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Class
caplin.grid.filter

QueryFilterExpression

Implements caplin.grid.filter.FilterExpression.
Represents a query expression that only supports ANDing field filters and only allows a field, identified by name, to be added once. See caplin.grid.filter.QueryFilterExpression#addFilter

This object is ideal to use with web services as the caplin.grid.filter.QueryFilterExpression#toQueryString method returns a string suitable for a web service call.

Constructor Summary

Attributes Name and Description
caplin.grid.filter.QueryFilterExpression()

Constructs a new QueryFilterExpression.

Method Summary

Attributes Name and Description
void addFilter(String sName, String sValue)

Adds a filter to the expression.
caplin.grid.filter.QueryFilterExpression clone()

Clones this instance of the QueryFilterExpression
<static> caplin.grid.filter.QueryFilterExpression clone(caplin.grid.filter.QueryFilterExpression oQueryFilterExpression)

Clones the QueryFilterExpression
void getFilterExpressions()

Gets the underlying operator for this QueryFilterExpression
Number getNumberOfFilterExpressions()

Gets the number of logical filter expressions that have been placed inside the FilterExpression.
void getOperator()

Gets the underlying operator for this QueryFilterExpression
void getRttpState()

void getSerializedState(String sIndent)

void hasFilter(String sName)

Checks to see if a filter with the given name already exists within the expression.
String toString()

Gets a text representation of the filter expression.
Methods implemented from class caplin.grid.filter.FilterExpression:
toMap

Constructor Detail

► caplin.grid.filter.QueryFilterExpression()

Constructs a new QueryFilterExpression.

Method Detail

► void addFilter(String sName, String sValue)

Adds a filter to the expression.

Parameters
String sName The name of the filter
String sValue the value of the filter
Throws
caplin.core.Error
if a filter with that name already exists within the expression

► caplin.grid.filter.QueryFilterExpression clone()

Clones this instance of the QueryFilterExpression

Returns
{caplin.grid.filter.QueryFilterExpression} a new instance of a QueryFilterExpression with exactly the same state.

► <static> caplin.grid.filter.QueryFilterExpression clone(caplin.grid.filter.QueryFilterExpression oQueryFilterExpression)

Clones the QueryFilterExpression

Parameters
caplin.grid.filter.QueryFilterExpression oQueryFilterExpression an instance of QueryFilterExpression to be cloned
Returns
{caplin.grid.filter.QueryFilterExpression} a new instance of a QueryFilterExpression with exactly the same state as the passed oQueryFilterExpression.

► void getFilterExpressions()

Gets the underlying operator for this QueryFilterExpression

Returns
The underlying LogicalFilterExpression operator

► Number getNumberOfFilterExpressions()

Gets the number of logical filter expressions that have been placed inside the FilterExpression.

Returns
Number of Filter expressions added to date.

► void getOperator()

Gets the underlying operator for this QueryFilterExpression

Returns
The underlying LogicalFilterExpression operator

► void getRttpState()

See
caplin.grid.filter.FilterExpression.getRttpState

► void getSerializedState(String sIndent)

Parameters
String sIndent The number of characters the caller would like the expression to indent the XML it returns to make it easily human readable.
See
caplin.grid.filter.FilterExpression.getSerializedState

► void hasFilter(String sName)

Checks to see if a filter with the given name already exists within the expression.

Parameters
String sName the name of the filter to check for
Returns
true if the filter exists within the expression; otherwise false.

► String toString()

Gets a text representation of the filter expression.

Returns
A text representation of the expression.