CustomElement.createFTBFilterStatement (Method)
Returns a string describing a 'formatted text block' filter statement. A 'formatted text block' statement is in the form {field} {operator} {value}, where the field is a formatted text block field, and the value is a string. Note the returned string is an internal string format so only use this method to create the statement string. One or more filter statements can then be combined to create a full QueryEngineFilter.
Returns:
FilterStatement (string)
Arguments:
Name | Type | Required | Description |
---|---|---|---|
customElementID | CustomElementID | Required | The custom element's ID against which to filter. |
fieldIDorName | PlainText_NonNull | Required | The unique ID or name of the custom element field the filter compares against. |
operator | QueryEngineFTBOperator | Required | The operator to use in the filter statement (i.e. Equals, Not Equals, Greater Than, etc). |
value | String | Required | The value against which the filter is applied. |
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 |
---|---|
9014 | The specified field ID '$1' does not exist for this custom element. |
9019 | The command only supports $1 field types. |
Notes:
None