7 Common parameter type definitions ToC Previous Next

7.7 ContentFilter ToC Previous Next

7.7.2 ContentFilterResult ToC Previous Next index

The components of this data type are defined in Table 119.

Table 119 – ContentFilterResult structure

Name Type Description
ContentFilterResult structure A structure that contains any errors associated with the filter.
   elementResults []    ContentFilterElementResult A list of results for individual elements in the filter. The size and order of the list matches the size and order of the elements in the ContentFilter parameter. This structure is defined in-line with the following indented items.
      statusCode StatusCode The status code for a single element.
      operandStatusCodes [] StatusCode A list of status codes for the operands in an element. The size and order of the list matches the size and order of the operands in the ContentFilterElement. This list is empty if no operand errors occurred.
      operandDiagnosticInfos [] DiagnosticInfo A list of diagnostic information for the operands in an element. The size and order of the list matches the size and order of the operands in the ContentFilterElement. This list is empty if diagnostics information was not requested in the request header or if no diagnostic information was encountered in processing of the operands.
   elementDiagnosticInfos [] DiagnosticInfo A list of diagnostic information for individual elements in the filter. The size and order of the list matches the size and order of the elements in the filter request parameter. This list is empty if diagnostics information was not requested in the request header or if no diagnostic information was encountered in processing of the elements.

Table 120 defines values for the StatusCode parameter that are specific to this structure. Common StatusCodes are defined in Table 183.

Table 120 – ContentFilterResult Result Codes

Symbolic Id Description
Bad_FilterOperandCountMismatch The number of operands provided for the filter operator was less than expected for the operand provided.
Bad_FilterOperatorInvalid An unrecognized operator was provided in a filter.
Bad_FilterOperatorUnsupported A valid operator was provided, but the Server does not provide support for this filter operator.

Table 121 defines values for the operandStatusCodes parameter that are specific to this structure. Common StatusCodes are defined in Table 183.

Table 121 – ContentFilterResult Operand Result Codes

Symbolic Id Description
Bad_FilterOperandInvalid See Table 183 for the description of this result code.
Bad_FilterElementInvalid The referenced element is not a valid element in the content filter.
Bad_FilterLiteralInvalid The referenced literal is not a valid BaseDataType.
Bad_AttributeIdInvalid The attribute id is not a valid attribute id in the system.
Bad_IndexRangeInvalid See Table 183 for the description of this result code.
Bad_NodeIdInvalid See Table 183 for the description of this result code.
Bad_NodeIdUnknown See Table 183 for the description of this result code.
Bad_NotTypeDefinition The provided NodeId was not a type definition NodeId.

Previous Next