Documentation
    Preparing search index...

    Class Disk

    Concrete Audio/Video Disk MDM Object Class (Extends AbstractMdmObject) Enforces MediaDiskSpecInterface over child Specification collection.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _dataObject _objectVendorsList _specificationsMap _repositoryInstance COLLECTION LABEL_KEY PARENT_PROP PROPS_DEFINITION REPOSITORY_CLASS

    Accessors

    _ dataObject path specifications specificationsCollectionName specificationsObject uid uri

    Methods

    addSpecification addVendor asReference delete get getArchetypeSpec getObjectVendors getSpecification getSpecifications getSubcollectionName getVendors has query save set setSpecification setSpecificationsFromObject toJSON val validate validateArchetypeSpecs daoFactory factory fillProperties fromBackend fromDataObject fromObject getProperty query registerRepository repository

    Constructors

    Properties

    Protected_dataObject

    _dataObject: DataObjectClass<any>

    Protected_objectVendorsList

    _objectVendorsList: ObjectVendor[] = []

    Protected_specificationsMap

    _specificationsMap: Map<string, Specification> = ...

    Protected Static_repositoryInstance

    _repositoryInstance: any = null
    COLLECTION: string = 'disks'

    The backend identifier (table or collection name) representing this class.

    LABEL_KEY: string = 'name'

    Which property's value to use in backend as label for object reference

    PARENT_PROP: string | undefined

    The name of the property handling hierarchical parent relationships.

    PROPS_DEFINITION: (
        | {
            default?: undefined;
            instanceOf?: undefined;
            name: string;
            parentKey?: undefined;
            required: boolean;
            type: string;
        }
        | {
            default: string;
            instanceOf?: undefined;
            name: string;
            parentKey?: undefined;
            required: boolean;
            type: string;
        }
        | {
            default?: undefined;
            instanceOf: string;
            name: string;
            parentKey?: undefined;
            required: boolean;
            type: string;
        }
        | {
            default?: undefined;
            instanceOf: typeof ObjectVendor;
            name: string;
            parentKey: string;
            required?: undefined;
            type: string;
        }
    )[] = ...

    The overarching property schema definition inherited and merged from BaseObject.

    REPOSITORY_CLASS: any = null

    The designated repository class for this model (defaults to BaseRepository).

    Accessors

    _

    • get _(): any

      Returns any

    • get dataObject(): DataObjectClass<any>

      Returns DataObjectClass<any>

    • get path(): string

      Returns string

    • get specificationsCollectionName(): string

      Returns the subcollection path for Specifications attached to this parent object. Scheme: //specifications

      Returns string

    • get specificationsObject(): Record<string, any>

      Returns a plain key-value object of all specifications for interface casting and validation.

      Returns Record<string, any>

    • get uid(): any

      Returns any

    • get uri(): ObjectUri

      Returns ObjectUri

    Methods

    • Associates a Vendor entity to this object via an ObjectVendor relationship record.

      Parameters

      • vendor: Vendor
      • OptionalvendorSku: string
      • Optionalrole: string
      • isPrimary: boolean = false

      Returns ObjectVendor

    • Generates a lightweight Reference representation of the object. Commonly used for NoSQL or object relational mapping.

      Returns any

      A standardized object reference.

    • Deletes the object from the backend database. By default, it performs a soft-delete (modifying the status property) unless hardDelete is enabled.

      Parameters

      • hardDelete: boolean = false

        If true, permanently removes the record from the database.

      Returns Promise<DataObjectClass<any>>

      A promise resolving to the underlying DataObjectClass.

    • Return property object matching key

      Parameters

      • key: string

        string

      Returns any

    • Returns the subcollection path for attaching N child subitems linked to this parent object. Scheme: //

      Parameters

      • subcollection: string

      Returns string

    • Checks if a property exists on the data object.

      Parameters

      • key: string

        The property key.

      Returns boolean

      True if the property exists.

    • Creates a chained query for child records originating from the current instance. Used mainly for NoSQL backends to query subcollections seamlessly.

      Parameters

      • obj: any

        The child class definition (e.g., LogModel) to query.

      Returns Query<any>

      A new Query builder scoped to this parent instance.

    • Persists the current state of the object to the configured backend database. Triggers creation or update operations depending on whether the object already exists.

      Returns Promise<Disk>

      A promise resolving to the instance itself for chaining.

    • Proxies a set command to the underlying data object.

      Parameters

      • key: string

        The property key.

      • val: any

        The value to assign.

      Returns any

      The DataObject instance for chaining.

    • Sets a specification key/value pair by instantiating a Specification model.

      Parameters

      • key: string
      • value: any
      • Optionalunit: string
      • Optionalgroup: string

      Returns Specification

    • Bulk populates specifications from a dictionary object.

      Parameters

      • specsObj: Record<string, any>

      Returns this

    • Serializes the current object path / identity.

      Returns any

      The JSON serialized ObjectUri.

    • Fetches the value of a property.

      Parameters

      • key: string

        The property key.

      Returns any

      The property value or null if undefined.

    • Validates the object's properties against the model definition. Throws a ValidationError if any mandatory properties are missing or empty.

      Returns void

    • Validates that the current instance specifications comply with the archetype's required and optional properties.

      Returns boolean

      True if valid; throws error if required specification properties are missing.

    • Orchestrates the creation of a DataObject linked to this class schema. Can dynamically read state from the backend if a URI is provided.

      Parameters

      • src: string | ObjectUri | DataObjectClass<any> | undefined = undefined

        The initialization source (ObjectUri, string path, or existing DAO).

      • child: any = ...

        The child class definition.

      Returns Promise<DataObjectClass<any>>

      A promise resolving to the fully instantiated DataObject.

    • Dynamically builds an instance of the class. It can hydrate from a raw data object, an ObjectUri, or a backend string path.

      Parameters

      • src: string | ObjectUri | undefined = undefined

        The source data: a string path, an ObjectUri, or raw object data.

      • child: any = ...

        The specific child class constructor to instantiate.

      Returns Promise<any>

      A promise resolving to the fully constructed and hydrated model instance.

      If instantiation fails.

    • Merges the parent class property definitions with the child's explicit properties.

      Parameters

      • child: any = ...

        The specific child class.

      Returns PersistedDataObject

      A factory-initialized DataObject representing the merged structure.

    • Fetches and hydrates an object directly from its backend storage path via the repository facade.

      Type Parameters

      • T

      Parameters

      • path: string

        The backend unique identifier or full URI path (e.g. "users/123" or "123").

      Returns Promise<T>

      A promise resolving to the populated class instance.

    • Looks up a property definition by its name from the merged PROPS_DEFINITION.

      Parameters

      • key: string

        The property name.

      Returns any

      The property definition object if found.

    • Registers an explicit repository instance for this model class.

      Parameters

      • repoInstance: any

        The repository instance to register.

      Returns void

    • Retrieves the pre-bound repository instance for this model class. Dynamically instantiates the default or customized BaseRepository if not already cached.

      Returns BaseRepository<any>

      The bound BaseRepository instance.

      If the default BaseRepository class has not been loaded/configured.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods