Description
The filterCondition class holds the base data for each filter condition.
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|---|---|---|---|
condition |
0..1 |
The filter condition (defaults to IS_EQUAL_TO) |
|
field |
string |
0..1 |
|
value |
string |
0..* |
The value or values the filter condition must match |
Remarks
Each filterCondition represents a criterion against which a given record searched by a 'list' call is matched. Details of how these are used are described under the searchFilter complex type.
The complex type consists of three parts: the field, the condition, and the value. The field identifies the name of the field within the complex type to be searched; this is a case-insensitive version of the member name, as set out in this document. The condition is an enum value, of type condition, which specifies how the match takes place, for instance IS_EQUAL_TO, or STARTS_WITH. The full list of available conditions are described under the simple type condition. The value specifies the value the field is to be matched against. Where a BETWEEN condition is specified, the value should be a two element array specifying the lower and upper bounds of acceptable values.