Home Manual Reference Source
import Assembly from 'pvbid-sdk/src/domain/Assembly.js'
public class | source

Assembly

Extends:

eventemitter3~EventEmitterAdvanceEventEmitterBidEntity → Assembly

Assembly Class

Constructor Summary

Public Constructor
public

constructor(assemblyData: object, bid: Bid)

Creates an instance of Assembly.

Member Summary

Public Members
public

bid: Bid

Reference to the bid that the assembly belongs to.

public get
public get

Method Summary

Public Methods
public

dirty()

Flags the assembly and corresponding bid as dirty and to be saved.

public

Find a field by its anchor value.

public

Removes a bid entity from the assembly.

Inherited Summary

From class AdvanceEventEmitter
public

Maximum number of events fired for the requester before events stop.

public

on(eventName: string, requesterId: string, callback: function)

public

onDelay(eventName: string, ms: number, requesterId: string, callback: function)

public

removeListenerByRequester(eventName: string, requesterId: string)

Removes event listeners by event and requesterId.

From class BidEntity
public get

Determine if the entity is in an assembly

public get

Gets the id of the bid entity.

public get

Gets the bid entity title.

public set

Sets the bid entity title.

public get

Gets the bid entity type.

public abstract

assess(dependency: BidEntity)

Assesses bid entity.

public

Gets an array of depndants that rely on the bid entity.

public

Gets all the dependencies that the bid entity relies on.

public

dirty()

Flags the bid entity as dirty and to be saved.

public

Exports the internal data for the bid entity.

public

Determines if bid entity relies on a null or undefined dependency value

public

async initSaveChangeLog(originalValue: *, newValue: *, valueType: *, entityProperty: *, metaData: *): *

public

Determines of bid entity is dirty.

public

Marks the bid entity as clean.

Public Constructors

public constructor(assemblyData: object, bid: Bid) source

Creates an instance of Assembly.

Override:

BidEntity#constructor

Params:

NameTypeAttributeDescription
assemblyData object
bid Bid

Public Members

public bid: Bid source

Reference to the bid that the assembly belongs to.

public get config: object source

public get definitionId: number source

Public Methods

public dirty() source

Flags the assembly and corresponding bid as dirty and to be saved.

Override:

BidEntity#dirty

public getFieldByAnchor(anchor: string): Field | undefined source

Find a field by its anchor value. Returns undefined if a match is not found.

Params:

NameTypeAttributeDescription
anchor string

Return:

Field | undefined

public removeBidEntity(type: string, id: number | string) source

Removes a bid entity from the assembly.

Params:

NameTypeAttributeDescription
type string
id number | string