CustomElement.createQueryEngineFilter (Method)

Returns a Query Engine Filter object, which is an array of one or more strings describing the filter. This array can then be passed to CustomElement.getRecordsFromSavedFilter() to retrieve custom element records.

Returns:

QueryEngineFilter (array)

Arguments:

Name Type Required Description
filterStatementArray FilterStatement_Array Required An array of one or more strings that describes the filter statements for a Query Engine Filter. Filter statements are then included in a filter expression, such as (1 AND 2) OR 3, where each number corresponds to the filter statement in the array.
filterExpression FilterExpression Optional. Defaults to an empty string. Must be a valid filter expression or an empty string. If an empty string all statements will be AND'd together. If not an empty string the filter expression should look something like this '(1 AND 2) OR 3', where the numbers represent the statements in the FilterStatementArray.

Context:

License Requirements (none)
Permission Requirements (none)
Deny Context (none)
Require Context (none)
Author Lock (not required)
Transaction Logging Transaction logging is disabled for this method
Customization This method may be customized at the site level

Error Codes:

Code Error Message
9021 Filter expression is not defined properly.

Notes:

None