eLabSDK2.Inventory.Sample

Hierarchy

Inventory

↳ Sample

↳↳ SampleDetail

↳↳ SampleList

↳↳ SeriesDetail

Methods

displaySampleQuantity

Static displaySampleQuantity(quantity): string

This function parses the quantity object to generate a display string.
This string can display only the base quantity and quantity unit, but when there is a maximum amount,
it will change the output so this is also displayed.

Parameters

Name	Type	Description
`quantity`	`QuantityInterface`	An object containing all the quantity data

Returns

string

the quantity display string

displaySampleQuantityThreshold

Static displaySampleQuantityThreshold(quantity): string | void

This function generates the display string of the quantity threshold based on given quantity object

Parameters

Name	Type	Description
`quantity`	`QuantityInterface`	An object containing all the quantity data

Returns

string | void

the quantity threshold display string

getSampleByID

Static getSampleByID(sampleID, filter?): Promise<SampleDetail>

Fetches the sample by the sample ID

Parameters

Name	Type	Description
`sampleID`	`number`	the id of the sample you want to fetch
`filter`	`Object`	-

Returns

Promise<SampleDetail>

An object containing the data of the sample

getSampleQuantity

Static getSampleQuantity(sampleID): Promise<QuantityInterface>

Fetches =the quantity data of a sample by its sample id

Parameters

Name	Type	Description
`sampleID`	`number`	the id of the sample of wich you want to know the quantity data

Returns

Promise<QuantityInterface>

An object containing all the quantity data of the sample

getSampleTypeSpecificationByID

Static getSampleTypeSpecificationByID(sampleTypeID, sampleTypeSpecificationID, filter?): Promise<any>

Fetches a specific sampleMetaSpecification of a sample type

Parameters

Name	Type	Description
`sampleTypeID`	`number`	the id of the sample type wich has the given sampleTypeSpecification
`sampleTypeSpecificationID`	`number`	the id of the sampleTypeSpecification you want to fetch
`filter?`	`GetSampleTypeSpecificationByIDOptions`	an object with the filters and expands that you want to be used for fetching the sampleTypeSpecifications

Returns

Promise<any>

An object containing all the data of the given sampleTypeSpecification