Skip to main content
Version: 2025.2

neonFilter

Methods​

createEntityRecordsRecipeBuilder​

createEntityRecordsRecipeBuilder(pRecordsRecipeAsJson?): EntityRecordsRecipeBuilder

Create and return a builder object for an entity record recipe from the given record recipe in json format.

Parameters​

pRecordsRecipeAsJson?
string | number | boolean

Returns​

EntityRecordsRecipeBuilder

An object for a entity record recipe; useful for working with several rows

Throws​

AditoIllegalArgumentException

createFilterCondition​

createFilterCondition(pFilterConditionAsJson?): FilterCondition

Creates a builder from the given filter condition in json format.

Parameters​

pFilterConditionAsJson?
string | number | boolean

Returns​

FilterCondition

Throws​

AditoIllegalArgumentException

createFilterGroup​

createFilterGroup(pFilterAsJson?): FilterGroup

Creates a builder from the given filter in json format.

Parameters​

pFilterAsJson?
string | number | boolean

Returns​

FilterGroup

Throws​

AditoIllegalArgumentException

Properties​

CONTENT_TYPE_BOOLEAN​

string

Constant for the content type.

Specifies the type of the content of an entity field.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.contentType(neonFilter.CONTENT_TYPE_BOOLEAN);

CONTENT_TYPE_DATE​

string

Constant for the content type.

Specifies the type of the content of an entity field.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.contentType(neonFilter.CONTENT_TYPE_DATE);

CONTENT_TYPE_EMAIL​

string

Constant for the content type.

Specifies the type of the content of an entity field.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.contentType(neonFilter.CONTENT_TYPE_EMAIL);

CONTENT_TYPE_HTML​

string

Constant for the content type.

Specifies the type of the content of an entity field.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.contentType(neonFilter.CONTENT_TYPE_HTML);

CONTENT_TYPE_LINK​

string

Constant for the content type.

Specifies the type of the content of an entity field.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.contentType(neonFilter.CONTENT_TYPE_LINK);

CONTENT_TYPE_LONG_TEXT​

string

Constant for the content type.

Specifies the type of the content of an entity field.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.contentType(neonFilter.CONTENT_TYPE_LONG_TEXT);

CONTENT_TYPE_NUMBER​

string

Constant for the content type.

Specifies the type of the content of an entity field.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.contentType(neonFilter.CONTENT_TYPE_NUMBER);

CONTENT_TYPE_PASSWORD​

string

Constant for the content type.

Specifies the type of the content of an entity field.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.contentType(neonFilter.CONTENT_TYPE_PASSWORD);

CONTENT_TYPE_TELEPHONE​

string

Constant for the content type.

Specifies the type of the content of an entity field.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.contentType(neonFilter.CONTENT_TYPE_TELEPHONE);

CONTENT_TYPE_TEXT​

string

Constant for the content type.

Specifies the type of the content of an entity field.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.contentType(neonFilter.CONTENT_TYPE_TEXT);

MERGE_OPERATOR_AND​

string

Constant for the merge operator.

Gives a merge operator that merges the different filters in the filter group with AND.

Example​

var filterGroupConfig = neonFilter.createFilterGroup();
  filterGroupConfig.mergeOperator(neonFilter.MERGE_OPERATOR_AND);

MERGE_OPERATOR_OR​

string

Constant for the merge operator.

Gives a merge operator that merges the different filters in the filter group with OR.

Example​

var filterGroupConfig = neonFilter.createFilterGroup();
  filterGroupConfig.mergeOperator(neonFilter.MERGE_OPERATOR_OR);

SEARCH_OPERATOR_CONTAINS​

string

Constant for the search operator.

Specifies a search operator indicating that the field must contain a value.

Usable for all content types where the input of text is possible.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.searchOperator(neonFilter.SEARCH_OPERATOR_CONTAINS);

SEARCH_OPERATOR_CONTAINSNOT​

string

Constant for the search operator.

Specifies a search operator indicating that the field will not contain a value.

Usable for all content types where the input of text is possible.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.searchOperator(neonFilter.SEARCH_OPERATOR_CONTAINSNOT);

SEARCH_OPERATOR_ENDSWITH​

string

Constant for the search operator.

Specifies a search operator indicating that the field must end with a value.

Usable for all content types where the input of text is possible.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.searchOperator(neonFilter.SEARCH_OPERATOR_ENDSWITH);

SEARCH_OPERATOR_EQUAL​

string

Constant for the search operator.

Specifies a search operator that indicates that the field must have the same value.

Usable for all content types.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.searchOperator(neonFilter.SEARCH_OPERATOR_EQUAL);

SEARCH_OPERATOR_EQUAL_ANY​

string

Constant for the search operator.

Specifies a search operator that indicates that the field must exist inside the filter condition.

Usable for all content types.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.searchOperator(neonFilter.SEARCH_OPERATOR_EQUAL_ANY);

SEARCH_OPERATOR_GREATER​

string

Constant for the search operator.

Specifies a search operator indicating that the field must have a greater value or the date takes place later.

Usable for content type DATE and NUMBER.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.searchOperator(neonFilter.SEARCH_OPERATOR_GREATER);

SEARCH_OPERATOR_GREATER_OR_EQUAL​

string

Constant for the search operator.

Specifies a search operator indicating that the field must have a greater or equal value or the date takes place later or on the same date.

Usable for content type DATE and NUMBER.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.searchOperator(neonFilter.SEARCH_OPERATOR_GREATER_OR_EQUAL);

SEARCH_OPERATOR_IN​

string

Constant for the search operator.

Specifies a search operator that indicates that the field must exist inside the filter condition.

Usable for all content types.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.searchOperator(neonFilter.SEARCH_OPERATOR_IN);

SEARCH_OPERATOR_ISNOTNULL​

string

Constant for the search operator.

Specifies a search operator indicating that the field is not null.

Usable for all content types except aggregate fields.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.searchOperator(neonFilter.SEARCH_OPERATOR_ISNOTNULL);

SEARCH_OPERATOR_ISNULL​

string

Constant for the search operator.

Specifies a search operator indicating that the field must be null.

Usable for all content types except aggregate fields.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.searchOperator(neonFilter.SEARCH_OPERATOR_ISNULL);

SEARCH_OPERATOR_LESS​

string

Constant for the search operator.

Specifies a search operator indicating that the field must have a smaller value or the date takes place earlier.

Usable for content type DATE and NUMBER.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.searchOperator(neonFilter.SEARCH_OPERATOR_LESS);

SEARCH_OPERATOR_LESS_OR_EQUAL​

string

Constant for the search operator.

Specifies a search operator indicating that the field must have a smaller or equal value or the date takes place earlier or on the same date.

Usable for content type DATE and NUMBER.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.searchOperator(neonFilter.SEARCH_OPERATOR_LESS_OR_EQUAL);

SEARCH_OPERATOR_NOT_EQUAL​

string

Constant for the search operator.

Specifies a search operator indicating that the field must must have a different value.

Usable for all content types.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.searchOperator(neonFilter.SEARCH_OPERATOR_NOT_EQUAL);

SEARCH_OPERATOR_NOT_IN​

string

Constant for the search operator.

Specifies a search operator that indicates that the field must not exist within the filter condition.

Usable for all content types.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.searchOperator(neonFilter.SEARCH_OPERATOR_NOT_IN);

SEARCH_OPERATOR_STARTSWITH​

string

Constant for the search operator.

Specifies a search operator indicating that the field must start with a value.

Usable for all content types where the input of text is possible.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.searchOperator(neonFilter.SEARCH_OPERATOR_STARTSWITH);

SEARCH_OPERATOR_TIMEFRAME_COMING​

string

Constant for the search operator.

Specifies a search operator indicating that the field must be in the coming time span.

Usable for content type DATE.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.searchOperator(neonFilter.SEARCH_OPERATOR_TIMEFRAME_COMING);
  filterConfig.key("REL=FIXED;END=P2D"); //the value is a positive Java Period

SEARCH_OPERATOR_TIMEFRAME_EQUAL​

string

Constant for the search operator.

Specifies a search operator indicating that the field must be within the time span.

Usable for content type DATE.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.searchOperator(neonFilter.SEARCH_OPERATOR_TIMEFRAME_EQUAL);
  filterConfig.key("REL=ADJUSTED;UNIT=DAY"); //possible units: YEAR, MONTH, WEEK, DAY

SEARCH_OPERATOR_TIMEFRAME_PAST​

string

Constant for the search operator.

Specifies a search operator indicating that the field must be in the past time span.

Usable for content type DATE.

Example​

var filterConfig = neonFilter.createFilterCondition();
  filterConfig.searchOperator(neonFilter.SEARCH_OPERATOR_TIMEFRAME_PAST);
  filterConfig.key("REL=FIXED;START=P-2D"); //the value is a negative Java Period