Report of a logical field value semantics verification. If some logical field, e.g. expiry date is present in multiple places in the document, it can occur that some entries are semantically correct and some are semantically incorrect. This report shows the overall status of the logical field value semantics verification and details for each field that was verified.

Hierarchy (view full)

Constructors

Properties

fieldDetails: FieldValueSemantics[]

List of value semantics for each field corresponding to the same logical field.

overallFieldValueSemantics: ValueSemantics

Overall status of the logical value semantics verification. Corresponds to the most severe status of all fields, i.e. if at least one field is semantically incorrect, the overall status is semantically incorrect. If no fields are present, the overall status is SKIPPED.

Methods

  • Parameters

    Returns {
        fieldDetails?: (undefined | {
            fieldFullName?: string;
            invalidSemantics?: boolean;
            serialize?: any;
        })[];
        overallFieldValueSemantics?: ValueSemantics;
        serialize?: any;
    }

    • Optional Readonly fieldDetails?: (undefined | {
          fieldFullName?: string;
          invalidSemantics?: boolean;
          serialize?: any;
      })[]

      List of value semantics for each field corresponding to the same logical field.

    • Optional Readonly overallFieldValueSemantics?: ValueSemantics

      Overall status of the logical value semantics verification. Corresponds to the most severe status of all fields, i.e. if at least one field is semantically incorrect, the overall status is semantically incorrect. If no fields are present, the overall status is SKIPPED.