Interface HumanValueGuard

Decides whether a target field's current value was entered by a person, records it, and retires it.

interface HumanValueGuard {
    IsHumanOwned(question: HumanValueQuestion): Promise<boolean>;
    RecordPreserved(
        fieldName: string,
        currentValue: unknown,
        provider: IMetadataProvider,
    ): Promise<void>;
    RetireHumanValue(
        fieldName: string,
        provider: IMetadataProvider,
    ): Promise<boolean>;
}

Implemented by

FeaturePipelineHumanValueGuard

Index

Methods

IsHumanOwned RecordPreserved RetireHumanValue

Methods

IsHumanOwned

IsHumanOwned(question: HumanValueQuestion): Promise<boolean>
True when the field's current value must be preserved.
Parameters
- question: HumanValueQuestion
Returns Promise<boolean>
- Defined in RecordSetProcessor/engine/src/writeBack.ts:43

RecordPreserved

RecordPreserved(
    fieldName: string,
    currentValue: unknown,
    provider: IMetadataProvider,
): Promise<void>
Records the preserved human value (a Source='Human' Feature Value) on the unit's provider. currentValue is unknown: the config-named field's value.
Parameters
- fieldName: string
- currentValue: unknown
- provider: IMetadataProvider
Returns Promise<void>
- Defined in RecordSetProcessor/engine/src/writeBack.ts:45

RetireHumanValue

RetireHumanValue(
fieldName: string,
provider: IMetadataProvider,
): Promise<boolean>
Retires the record's Human value of the field (an overwriting run made it the pipeline's); true when one existed.
Parameters
- fieldName: string
- provider: IMetadataProvider
Returns Promise<boolean>
- Defined in RecordSetProcessor/engine/src/writeBack.ts:47

Interface HumanValueGuard

Implemented by

Index

Methods

Methods

IsHumanOwned

Parameters

Returns Promise<boolean>

RecordPreserved

Parameters

Returns Promise<void>

RetireHumanValue

Parameters

Returns Promise<boolean>

Settings

On This Page