import ComponentGroup from 'pvbid-sdk/src/domain/ComponentGroup.js'

public class | source

ComponentGroup

eventemitter3~EventEmitter → AdvanceEventEmitter → BidEntity → ComponentGroup

Component Group Class

Constructor Summary

Public Constructor
public	constructor(componentGroupData: object, bid: Bid) Creates an instance of ComponentGroup.

Public Members
public	bid: Bid Reference to the bid that the component group belongs to.
public get	config: object Config Getter.
public get	definitionId: *

Public Methods
public	dirty() Flags the component group and corresponding bid as dirty and to be saved.
public	getComponents(topLevelOnly: boolean): object Retrieves the bid components that belong to the component group

From class AdvanceEventEmitter
public	maxEvents: number 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	hasAssembly: boolean Determine if the entity is in an assembly
public get	id: number \| string Gets the id of the bid entity.
public get	title: string Gets the bid entity title.
public set	title: string Sets the bid entity title.
public get	type: string Gets the bid entity type.
public abstract	assess(dependency: BidEntity) Assesses bid entity.
public	dependants(): BidEntity[] Gets an array of depndants that rely on the bid entity.
public	dependencies(): BidEntity[] Gets all the dependencies that the bid entity relies on.
public	dirty() Flags the bid entity as dirty and to be saved.
public	exportData(): object Exports the internal data for the bid entity.
public	hasNullDependency(field: string): boolean Determines if bid entity relies on a null or undefined dependency value
public	async initSaveChangeLog(originalValue: , newValue: , valueType: , entityProperty: , metaData: ):
public	isDirty(): boolean Determines of bid entity is dirty.
public	pristine() Marks the bid entity as clean.

Creates an instance of ComponentGroup.

Reference to the bid that the component group belongs to.

Config Getter.

Flags the component group and corresponding bid as dirty and to be saved.

Retrieves the bid components that belong to the component group

Name	Type	Attribute	Description
topLevelOnly	boolean		get only the top level components in the group

components keyed by their reference