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

public class | source

FieldGroup

Extends:

eventemitter3~EventEmitter → AdvanceEventEmitter → BidEntity → FieldGroup

Field Group Class

Constructor Summary

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

Member Summary

Public Members
public	bid: Bid Reference to the bid that the field group belongs to.
public get	config: object Holds the Field Group configuration information.

Method Summary

Public Methods
public	dirty() Flags the field group and corresponding bid as dirty and to be saved.
public	getAssembly(): *
public	getFields(): object Retrieve the fields belonging to the group keyed by reference
public	isDirty(): boolean Determines if the field group is changed for it's original data.
public	setAssembly(assembly: Assembly \| string): Assembly Adds the field group to an assembly.
public	unsetAssembly(): void Removes any assembly reference from the field group.

Inherited Summary

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.

Public Constructors

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

Creates an instance of FieldGroup.

Override:

BidEntity#constructor

Params:

Name	Type	Attribute	Description
fieldGroupData	object
bid	Bid

Public Members

public bid: Bid source

Reference to the bid that the field group belongs to.

public get config: object source

Holds the Field Group configuration information.

Public Methods

public dirty() source

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

Override:

BidEntity#dirty

public getAssembly(): * source

Return:

public getFields(): object source

Retrieve the fields belonging to the group keyed by reference

Return:

object

public isDirty(): boolean source

Determines if the field group is changed for it's original data.

Override:

BidEntity#isDirty

Return:

boolean

public setAssembly(assembly: Assembly | string): Assembly source

Adds the field group to an assembly.

Params:

Name	Type	Attribute	Description
assembly	Assembly \| string		The assembly entity or an assembly ref id

Return:

Assembly

the new assembly setting

public unsetAssembly(): void source

Removes any assembly reference from the field group.

Return:

void