Requirement | TS4OCDS

An atomic requirement. Requirements can specify the expected value that the response has to contain, or a range of threshold values within which the response has to fit in. The requirement may apply to a certain period of time.

Constructors

constructor

Properties

Methods

Constructors

constructor

(initializer: Initializer<Requirement>): Requirement

Properties

dataType Optional

: DataType

The data type in which the requirement response must be provided.

description Optional

: undefined | string

A free text description for this atomic requirement.

id

: string

The identifier for this requirement. It must be unique and cannot change within the Open Contracting Process it is part of (defined by a single ocid). See the identifier guidance for further details.

period Optional

: Period

Used to specify a particular period the requirement applies to, for example the bidder's turnover in a given year.

title Optional

: undefined | string

The title of this atomic requirement.

options Static Optional

: Option[]

Methods

isOfType

(type: "boolean"): this is BooleanRequirement
(type: "string"): this is StringRequirement
(type: "number" | "integer" | "numeric"): this is NumericRequirement

Used to check if the requirement is of boolean data type.
Used to check if the requirement is of string data type.
Used to check if the requirement is of numeric data type. numeric is accepted for checking for both number and integer at the same time.

isRanged

(requirement: Requirement): this is RangedRequirement

Used to check if the requirement has specified numeric value range [minValue, maxValue].

toReference

(): RequirementReference

Creates an instance of a RequirementReference class from this Requirement.

toResponse

(id: RequirementResponse["id"]): RequirementResponse
(id: RequirementResponse["id"], value: BooleanRequirementResponse["value"]): BooleanRequirementResponse
(id: RequirementResponse["id"], value: StringRequirementResponse["value"]): StringRequirementResponse
(id: RequirementResponse["id"], value: NumericRequirementResponse["value"]): NumericRequirementResponse

Creates an instance of a RequirementResponse class from this Requirement.
Creates an instance of a RequirementResponse class from this Requirement. Holds a shape of a BooleanRequirementResponse.
Creates an instance of a RequirementResponse class from this Requirement. Holds a shape of a StringRequirementResponse.
Creates an instance of a RequirementResponse class from this Requirement. Holds a shape of a NumericRequirementResponse.