Class ConcreteLocalFDORecord

ReadonlyPID

addAttribute

• addAttribute<Attr extends Attribute<RecordValue>>(
      attribute: string | Attr,
      value: Attr extends Attribute<T> ? T : RecordValue,
  ): void

  Add an attribute to the record. This method does not override existing data.

  Type Parameters

  • Attr extends Attribute<RecordValue>

  Parameters

  • attribute: string | Attr

    PID of the attribute

  • value: Attr extends Attribute<T> ? T : RecordValue

    New value of the attribute. Can be an array to add multiple values, if allowed by the attribute.

  Returns void

addProfile

• addProfile<P extends Profile<ProfileAttributes>>(
      profile: P,
      attributes: P extends Profile<I> ? WithMarkers<I> : never,
  ): void

  Mark this record as conformant to the specified profile and add at least the required attributes of the profile.

  Type Parameters

  • P extends Profile<ProfileAttributes>

  Parameters

  • profile: P

    The profile to conform to

  • attributes: P extends Profile<I> ? WithMarkers<I> : never

    An object containing at least all required attributes of the profile. May also contain optional attributes. You may use reference, keep and skip.

  Returns void

addRecord

• addRecord(record: FDORecord): void

  Add the contents of another record to this record. This method does not override existing data.

  Parameters

  • record: FDORecord

    Other FDORecord to copy attributes from

  Returns void

addReference

• addReference(
      fromAttribute: string | Attribute<string | string[]>,
      toRecord: string | LocalFDORecord | PublishedFDORecord,
  ): void

  Add a unidirectional reference from this record to another record. The target record must either be known locally or be resolvable via its PID

  Parameters

  • fromAttribute: string | Attribute<string | string[]>

    The attribute of this record where the reference will be placed

  • toRecord: string | LocalFDORecord | PublishedFDORecord

    the record that should be referenced, or a local ID (LocalID) or PID of the referenced record. Must either be known locally or be resolvable via its PID

  Returns void

  See

  FDORecord.addReferenceBidi for bidirectional references

addReferenceBidi

• addReferenceBidi(
      fromAttribute: string | Attribute<string | string[]>,
      inverseAttribute: string | Attribute<string | string[]>,
      toRecord: string | LocalFDORecord | PublishedFDORecord,
  ): void

  Add a bidirectional reference from this record to another record and back. The target record must be in the current local or remote graph in order to create the back-reference

  Parameters

  • fromAttribute: string | Attribute<string | string[]>

    The attribute of this record where the reference will be placed

  • inverseAttribute: string | Attribute<string | string[]>
  • toRecord: string | LocalFDORecord | PublishedFDORecord

    the record that should be referenced, or a local ID (LocalID) or PID of the referenced record. Must either be known locally or be resolvable via its PID

  Returns void

  See

  FDORecord.addReference for unidirectional references

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

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

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[]

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[]

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

remove

• remove(attribute: string): void

  Remove the attribute and all its values from the record

  Parameters

  • attribute: string

    PID or Attribute instance of the attribute

  Returns void

set

• set<T extends RecordValue>(attribute: Attribute<T>, value: T): void

  Set the value of the specified attribute. Will add the attribute to the record if it does not exist yet. Will replace (all) existing value(s) of this attribute with the specified value.

  Type Parameters

  • T extends RecordValue

  Parameters

  • attribute: Attribute<T>

    PID of the attribute.

  • value: T

    New value of the attribute. Can be an array to add multiple values, if allowed by the attribute.

  Returns void

• set(attribute: string, value: RecordValue): void

  Set the value of the specified attribute. Will add the attribute to the record if it does not exist yet. Will replace (all) existing value(s) of this attribute with the specified value.

  Parameters

  • attribute: string

    Attribute instance of the attribute.

  • value: RecordValue

    New value of the attribute. Can be an array to add multiple values, if allowed by the attribute.

  Returns void

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>