Interface ReadOnlyFDORecord

Represents a single FDO record that is optionally associated with a registered PID. Read-only.

A record consists of attributes, each with one or more values. Each attribute is uniquely identified by its PID.

interface ReadOnlyFDORecord {
    PID: string | undefined;
    get(attribute: string | Attribute<never>): RecordValue | undefined;
    getAll(): Map<string, RecordValue>;
    getProfiles(): string[];
    getReferences(): ReferenceDeclaration[];
    has(attribute: string | Attribute<never>): boolean;
    toJSON(): Record<string, RecordValue>;
    toString(): string;
}

Hierarchy (View Summary)

ReadOnlyFDORecord
- FDORecord

Index

Properties

Methods

get getAll getProfiles getReferences has toJSON toString

Properties

`Readonly`PID

PID: string | undefined

The globally unique and registered identifier of this record. Undefined only if this record has not been published yet.

Methods

get

get(attribute: string | Attribute<never>): RecordValue | undefined
Retrieve the values(s) of an attribute in this record.
Parameters
- attribute: string | Attribute<never>
  PID or Attribute instance of the attribute
Returns RecordValue | undefined
the value of the attribute, or undefined if the attribute is not present on this record
- Defined in primitives/src/interfaces/FDORecord.ts:163

getAll

getAll(): Map<string, RecordValue>
Get a map of all attributes present on this record

Returns Map<string, RecordValue>
a map of attribute PIDs to attribute values
- Defined in primitives/src/interfaces/FDORecord.ts:169

getProfiles

getProfiles(): string[]
Get a list of profiles this record conforms to. Can be used for validation. Each profile is globally identified by its PID.

Returns string[]
- Defined in primitives/src/interfaces/FDORecord.ts:181

getReferences

getReferences(): ReferenceDeclaration[]
Get a list of outgoing references from this record to other records. Locally used to realize bidirectional references when the FDO Graph is published.

Returns ReferenceDeclaration[]
- Defined in primitives/src/interfaces/FDORecord.ts:175

has

has(attribute: string | Attribute<never>): boolean
Check whether a specific attribute is present on this record
Parameters
- attribute: string | Attribute<never>
  PID or Attribute instance of the attribute
Returns boolean
- Defined in primitives/src/interfaces/FDORecord.ts:187

toJSON

toJSON(): Record<string, RecordValue>
Returns the contents of this record in a plain format, to be used with JSON.stringify

Returns Record<string, RecordValue>
- Defined in primitives/src/interfaces/FDORecord.ts:193

toString

toString(): string
Returns the content of this record as a string, mainly useful for logging and debugging.

Returns string
- Defined in primitives/src/interfaces/FDORecord.ts:199