Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReturnValue

Wraps a return value used in the HIRMG and HIRMS segments.

Hierarchy

  • ReturnValue

Index

Constructors

Properties

Accessors

Constructors

constructor

Properties

code

code: string

The return value's code. Identifies the purpose of the return value and also specifies whether it's a notification of succes, a warning or an error.

message

message: string

A human readable message.

parameters

parameters: string[]

Arbitrary parameters.

references

references: number[]

A return value might reference a set of certain segments of a referenced request, for example if it was a warning or an error in a HIRMS segment.

Accessors

error

  • get error(): boolean
  • Will be true if the return value was an error (code starts with "9").

    Returns boolean

success

  • get success(): boolean
  • Will be true if the return value was a successful one (code starts with "0").

    Returns boolean

warning

  • get warning(): boolean
  • Will be true if the return value was warning (code starts with "3").

    Returns boolean

Generated using TypeDoc