2.2.2.1.3.1 Filters
Filters have the following format.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Query Changes Filter Start |
|||||||||||||||||||||||||||||||
|
Filter Type |
Filter Operation |
Query Changes Filter Data |
|||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
Query Changes Filter End |
Query Changes Filter Flags |
||||||||||||||||||||||||||||||
|
... |
F |
Reserved |
|||||||||||||||||||||||||||||
Query Changes Filter Start (4 bytes): A 32-bit Stream Object Header (section 2.2.1.5.2) that specifies a Query Changes filter start.
Filter Type (1 byte): An unsigned integer that specifies filter type as follows.
|
Value |
Type |
|---|---|
|
1 |
All filter (section 2.2.2.1.3.1.1). |
|
2 |
Data element type filter (section 2.2.2.1.3.1.2). |
|
3 |
Storage Index referenced data elements filter (section 2.2.2.1.3.1.3). |
|
4 |
Cell ID filter (section 2.2.2.1.3.1.4). |
|
5 |
Custom filter (section 2.2.2.1.3.1.5). |
|
6 |
Data element IDs filter (section 2.2.2.1.3.1.6). |
|
7 |
Hierarchy filter (section 2.2.2.1.3.1.7). |
Filter Operation (1 byte): A flag that specifies how the filter is applied to the data elements before they are added to the response Data Element Package (section 2.2.1.12). This field MUST be set to zero or one. A value of zero specifies that any data elements matching the filter will be excluded from the response Data Element Package. A value of one specifies that any data elements matching the filter will be included in the response Data Element Package, even if they have been excluded by another filter prior to this filter in the ordered array of filters.
Query Changes Filter Data (variable): A structure that specifies additional data based on the filter type.
Query Changes Filter End (2 bytes): A 16-bit Stream Object Header (section 2.2.1.5.4) that specifies the end of a Query Changes filter.
Query Changes Filter Flags (4 bytes): An optional 32-bit Stream Object Header that specifies the beginning of Query Changes filter flags.
F – Fail if Unsupported (1 bit): If set, a bit that specifies to one to allow failure if a filter is not supported; otherwise, unsupported filters are ignored. This bit is only sent if Query Changes filter flags are specified.
Reserved (7 bits): A 7-bit reserved field that MUST be set to zero, and MUST be ignored if Query Changes filter flags are specified.