Class Index | File Index

Classes


Class LABKEY.Query.Filter

This class is used to construct filters when using APIs such as LABKEY.Query.GetData.getRawData, LABKEY.Query.selectRows, or LABKEY.Query.executeSql. This is the base filter class, which requires the user specify a filter type from LABKEY.Filter#Types. Users can avoid the need for specifying a filter type by using a subclass of Filter such as LABKEY.Query.Filter.Equals or LABKEY.Query.Filter.GreaterThan, which will automatically set the type for the user.
Defined in: Query.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
LABKEY.Query.Filter(columnName, value, filterType)
Method Summary
Method Attributes Method Name and Description
 
Gets the column name used in the filter.
 
Gets the filter type used to construct the filter.
 
getURLParameterName(dataRegionName)
Returns the URL parameter name used for the filter.
 
Returns the value that will be put on URL.
 
Returns the value of the filter.
Class Detail
LABKEY.Query.Filter(columnName, value, filterType)
Parameters:
{String} columnName
Required. The name of the column the filter will be applied Can be a string, array of strings, or a LABKEY.FieldKey
{LABKEY.Filter#Types} filterType
Type of filter to apply to the 'column' using the 'value'
value
Value used as the filter criterion or an Array of values.
Method Detail
{String} getColumnName()
Gets the column name used in the filter.
Returns:
{String}

{LABKEY.Filter#Types} getFilterType()
Gets the filter type used to construct the filter.
Returns:
{LABKEY.Filter#Types}

{String} getURLParameterName(dataRegionName)
Returns the URL parameter name used for the filter.
Parameters:
dataRegionName
The dataRegionName the filter is associated with.
Returns:
{String}

{String} getURLParameterValue()
Returns the value that will be put on URL.
Returns:
{String}

{*} getValue()
Returns the value of the filter.
Returns:
{*}

Documentation generated by JsDoc Toolkit 2.3.2 on Thu Mar 16 2017 20:36:35 GMT-0000 (UTC)