Interface PreferenceState

Encapsulates typed und untyped workflow metadata for case properties

interface PreferenceState {
    DE_A1200?: string;
    NC_38000?: string;
    bbox?: Bbox;
    confidence?: number;
    country?: string;
    countryGroup?: string;
    display?: boolean;
    errors?: ErrorModel[];
    input?: string;
    lastChangedBy?: string;
    modifiedAt?: number;
    modifiedBy?: {
        displayName?: string;
        id?: string;
    };
    options?: boolean[];
    reason?: any;
    required?: boolean;
    reviewNeeded?: boolean;
    searchValue?: string;
    source?: string;
    treaty?: string;
    userEdited?: boolean;
    value?: boolean;
}

Hierarchy (view full)

  • Meta<boolean>
    • PreferenceState

Properties

DE_A1200?: string
NC_38000?: string
bbox?: Bbox

Bounding box of extracted value

confidence?: number

Confidence supplied by data extraction or 1.0 if entered by human

country?: string
countryGroup?: string

e.g. LDC

display?: boolean
errors?: ErrorModel[]

could be validation errors

input?: string

The input value which was initially supplied for the property

lastChangedBy?: string

Encoded user (username, userId, etc.)

Deprecated

modifiedAt?: number

Last modification date (user or machine), as a UTC unix timestamp

modifiedBy?: {
    displayName?: string;
    id?: string;
}

Field last changed by

Type declaration

  • Optional displayName?: string
  • Optional id?: string
options?: boolean[]
reason?: any
required?: boolean
reviewNeeded?: boolean
searchValue?: string

Normalized searchValue, for any related queries. Needs to be a string, even if value is of a different type.

source?: string
treaty?: string

the treaty the preference decision is based on

userEdited?: boolean

Mark this property as user-edited (as opposed to machine-generated)

value?: boolean

defines preference state

Generated using TypeDoc