Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_RawSubstance" of service "API_RAWSUBSTANCE". See https://api.sap.com/api/API_RAWSUBSTANCE for more information.

Hierarchy

  • Entity
    • RawSubstance

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns RawSubstance

Properties

Protected _customFields

_customFields: MapType<any>

A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.

Protected _versionIdentifier

_versionIdentifier: string

The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".

Optional rawSubstance

rawSubstance: string

Raw Substance. Maximum length: 12.

nullable

Optional rawSubstanceAuthznGroup

rawSubstanceAuthznGroup: string

Description of Authorization Group. Maximum length: 10.

nullable

Optional rawSubstanceChangeDate

rawSubstanceChangeDate: Moment

Changed On.

nullable

Optional rawSubstanceChangedByUser

rawSubstanceChangedByUser: string

Last Changed By. Maximum length: 12.

nullable

Optional rawSubstanceChangedByUserName

rawSubstanceChangedByUserName: string

Specification Changed By Name. Maximum length: 80.

nullable

Optional rawSubstanceCreatedByUser

rawSubstanceCreatedByUser: string

Created By. Maximum length: 12.

nullable

Optional rawSubstanceCreatedByUserName

rawSubstanceCreatedByUserName: string

Specification Header Created By Name. Maximum length: 80.

nullable

Optional rawSubstanceCreationDate

rawSubstanceCreationDate: Moment

Created On.

nullable

rawSubstanceInternalId

rawSubstanceInternalId: string

Sequential Number of Data Record. Maximum length: 20.

Optional rawSubstanceType

rawSubstanceType: string

Specification Type. Maximum length: 10.

nullable

Protected remoteState

remoteState: object

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.

Type declaration

  • [keys: string]: any

Optional specificationCategory

specificationCategory: string

Specification Category. Maximum length: 10.

nullable

Optional specificationHdrStsSchema

specificationHdrStsSchema: string

Status Scheme. Maximum length: 20.

nullable

Optional specificationHeaderStatus

specificationHeaderStatus: string

Status Identification. Maximum length: 20.

nullable

Optional specificationNote

specificationNote: string

Note. Maximum length: 60.

nullable

toRawSubstanceAllergenComp

toRawSubstanceAllergenComp: SpecValAssgmtInstanceWthComp[]

One-to-many navigation property to the SpecValAssgmtInstanceWthComp entity.

toRawSubstanceAuthznGroupText

toRawSubstanceAuthznGroupText: SpecAuthorizationGroupText[]

One-to-many navigation property to the SpecAuthorizationGroupText entity.

toRawSubstanceComponentType

toRawSubstanceComponentType: SpecCharByValueAssgmtInst[]

One-to-many navigation property to the SpecCharByValueAssgmtInst entity.

toRawSubstanceConversionFactor

toRawSubstanceConversionFactor: SpecCharByValueAssgmtInst[]

One-to-many navigation property to the SpecCharByValueAssgmtInst entity.

toRawSubstanceDensity

toRawSubstanceDensity: SpecCharByValueAssgmtInst[]

One-to-many navigation property to the SpecCharByValueAssgmtInst entity.

toRawSubstanceDietComp

toRawSubstanceDietComp: SpecValAssgmtInstanceWthComp[]

One-to-many navigation property to the SpecValAssgmtInstanceWthComp entity.

toRawSubstanceEstimatedPrice

toRawSubstanceEstimatedPrice: SpecCharByValueAssgmtInst[]

One-to-many navigation property to the SpecCharByValueAssgmtInst entity.

toRawSubstanceGmoComp

toRawSubstanceGmoComp: SpecValAssgmtInstanceWthComp[]

One-to-many navigation property to the SpecValAssgmtInstanceWthComp entity.

toRawSubstanceIdentifier

toRawSubstanceIdentifier: SpecIdentifier[]

One-to-many navigation property to the SpecIdentifier entity.

toRawSubstanceMatlAssignment

toRawSubstanceMatlAssignment: SpecAssignedMatlForKeyDate[]

One-to-many navigation property to the SpecAssignedMatlForKeyDate entity.

toRawSubstanceNextStatus

toRawSubstanceNextStatus: SpecStatusNextStatus[]

One-to-many navigation property to the SpecStatusNextStatus entity.

toRawSubstanceNtrntComp

toRawSubstanceNtrntComp: SpecValAssgmtInstanceWthComp[]

One-to-many navigation property to the SpecValAssgmtInstanceWthComp entity.

toRawSubstanceReligiousComp

toRawSubstanceReligiousComp: SpecValAssgmtInstanceWthComp[]

One-to-many navigation property to the SpecValAssgmtInstanceWthComp entity.

toRawSubstanceSchema

toRawSubstanceSchema: SpecStatusSchema[]

One-to-many navigation property to the SpecStatusSchema entity.

toRawSubstanceStatusAttributes

toRawSubstanceStatusAttributes: SpecStatusAttributes[]

One-to-many navigation property to the SpecStatusAttributes entity.

toRawSubstanceStdComp

toRawSubstanceStdComp: SpecValAssgmtInstanceWthComp[]

One-to-many navigation property to the SpecValAssgmtInstanceWthComp entity.

toRawSubstanceTotalSolid

toRawSubstanceTotalSolid: SpecCharByValueAssgmtInst[]

One-to-many navigation property to the SpecCharByValueAssgmtInst entity.

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

The ETag version identifier of the retrieved entity, returns undefined if not retrieved

Static ALL_FIELDS

ALL_FIELDS: AllFields<RawSubstance> = new AllFields('*', RawSubstance)

All fields selector.

Static RAW_SUBSTANCE

RAW_SUBSTANCE: StringField<RawSubstance> = new StringField('RawSubstance', RawSubstance, 'Edm.String')

Static representation of the rawSubstance property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RAW_SUBSTANCE_AUTHZN_GROUP

RAW_SUBSTANCE_AUTHZN_GROUP: StringField<RawSubstance> = new StringField('RawSubstanceAuthznGroup', RawSubstance, 'Edm.String')

Static representation of the rawSubstanceAuthznGroup property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RAW_SUBSTANCE_CHANGED_BY_USER

RAW_SUBSTANCE_CHANGED_BY_USER: StringField<RawSubstance> = new StringField('RawSubstanceChangedByUser', RawSubstance, 'Edm.String')

Static representation of the rawSubstanceChangedByUser property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RAW_SUBSTANCE_CHANGED_BY_USER_NAME

RAW_SUBSTANCE_CHANGED_BY_USER_NAME: StringField<RawSubstance> = new StringField('RawSubstanceChangedByUserName', RawSubstance, 'Edm.String')

Static representation of the rawSubstanceChangedByUserName property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RAW_SUBSTANCE_CHANGE_DATE

RAW_SUBSTANCE_CHANGE_DATE: DateField<RawSubstance> = new DateField('RawSubstanceChangeDate', RawSubstance, 'Edm.DateTime')

Static representation of the rawSubstanceChangeDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RAW_SUBSTANCE_CREATED_BY_USER

RAW_SUBSTANCE_CREATED_BY_USER: StringField<RawSubstance> = new StringField('RawSubstanceCreatedByUser', RawSubstance, 'Edm.String')

Static representation of the rawSubstanceCreatedByUser property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RAW_SUBSTANCE_CREATED_BY_USER_NAME

RAW_SUBSTANCE_CREATED_BY_USER_NAME: StringField<RawSubstance> = new StringField('RawSubstanceCreatedByUserName', RawSubstance, 'Edm.String')

Static representation of the rawSubstanceCreatedByUserName property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RAW_SUBSTANCE_CREATION_DATE

RAW_SUBSTANCE_CREATION_DATE: DateField<RawSubstance> = new DateField('RawSubstanceCreationDate', RawSubstance, 'Edm.DateTime')

Static representation of the rawSubstanceCreationDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RAW_SUBSTANCE_INTERNAL_ID

RAW_SUBSTANCE_INTERNAL_ID: StringField<RawSubstance> = new StringField('RawSubstanceInternalID', RawSubstance, 'Edm.String')

Static representation of the rawSubstanceInternalId property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static RAW_SUBSTANCE_TYPE

RAW_SUBSTANCE_TYPE: StringField<RawSubstance> = new StringField('RawSubstanceType', RawSubstance, 'Edm.String')

Static representation of the rawSubstanceType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SPECIFICATION_CATEGORY

SPECIFICATION_CATEGORY: StringField<RawSubstance> = new StringField('SpecificationCategory', RawSubstance, 'Edm.String')

Static representation of the specificationCategory property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SPECIFICATION_HDR_STS_SCHEMA

SPECIFICATION_HDR_STS_SCHEMA: StringField<RawSubstance> = new StringField('SpecificationHdrStsSchema', RawSubstance, 'Edm.String')

Static representation of the specificationHdrStsSchema property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SPECIFICATION_HEADER_STATUS

SPECIFICATION_HEADER_STATUS: StringField<RawSubstance> = new StringField('SpecificationHeaderStatus', RawSubstance, 'Edm.String')

Static representation of the specificationHeaderStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SPECIFICATION_NOTE

SPECIFICATION_NOTE: StringField<RawSubstance> = new StringField('SpecificationNote', RawSubstance, 'Edm.String')

Static representation of the specificationNote property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_RAW_SUBSTANCE_ALLERGEN_COMP

TO_RAW_SUBSTANCE_ALLERGEN_COMP: Link<RawSubstance, SpecValAssgmtInstanceWthComp> = new Link('to_RawSubstanceAllergenComp', RawSubstance, SpecValAssgmtInstanceWthComp)

Static representation of the one-to-many navigation property toRawSubstanceAllergenComp for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_RAW_SUBSTANCE_AUTHZN_GROUP_TEXT

TO_RAW_SUBSTANCE_AUTHZN_GROUP_TEXT: Link<RawSubstance, SpecAuthorizationGroupText> = new Link('to_RawSubstanceAuthznGroupText', RawSubstance, SpecAuthorizationGroupText)

Static representation of the one-to-many navigation property toRawSubstanceAuthznGroupText for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_RAW_SUBSTANCE_COMPONENT_TYPE

TO_RAW_SUBSTANCE_COMPONENT_TYPE: Link<RawSubstance, SpecCharByValueAssgmtInst> = new Link('to_RawSubstanceComponentType', RawSubstance, SpecCharByValueAssgmtInst)

Static representation of the one-to-many navigation property toRawSubstanceComponentType for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_RAW_SUBSTANCE_CONVERSION_FACTOR

TO_RAW_SUBSTANCE_CONVERSION_FACTOR: Link<RawSubstance, SpecCharByValueAssgmtInst> = new Link('to_RawSubstanceConversionFactor', RawSubstance, SpecCharByValueAssgmtInst)

Static representation of the one-to-many navigation property toRawSubstanceConversionFactor for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_RAW_SUBSTANCE_DENSITY

TO_RAW_SUBSTANCE_DENSITY: Link<RawSubstance, SpecCharByValueAssgmtInst> = new Link('to_RawSubstanceDensity', RawSubstance, SpecCharByValueAssgmtInst)

Static representation of the one-to-many navigation property toRawSubstanceDensity for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_RAW_SUBSTANCE_DIET_COMP

TO_RAW_SUBSTANCE_DIET_COMP: Link<RawSubstance, SpecValAssgmtInstanceWthComp> = new Link('to_RawSubstanceDietComp', RawSubstance, SpecValAssgmtInstanceWthComp)

Static representation of the one-to-many navigation property toRawSubstanceDietComp for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_RAW_SUBSTANCE_ESTIMATED_PRICE

TO_RAW_SUBSTANCE_ESTIMATED_PRICE: Link<RawSubstance, SpecCharByValueAssgmtInst> = new Link('to_RawSubstanceEstimatedPrice', RawSubstance, SpecCharByValueAssgmtInst)

Static representation of the one-to-many navigation property toRawSubstanceEstimatedPrice for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_RAW_SUBSTANCE_GMO_COMP

TO_RAW_SUBSTANCE_GMO_COMP: Link<RawSubstance, SpecValAssgmtInstanceWthComp> = new Link('to_RawSubstanceGMOComp', RawSubstance, SpecValAssgmtInstanceWthComp)

Static representation of the one-to-many navigation property toRawSubstanceGmoComp for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_RAW_SUBSTANCE_IDENTIFIER

TO_RAW_SUBSTANCE_IDENTIFIER: Link<RawSubstance, SpecIdentifier> = new Link('to_RawSubstanceIdentifier', RawSubstance, SpecIdentifier)

Static representation of the one-to-many navigation property toRawSubstanceIdentifier for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_RAW_SUBSTANCE_MATL_ASSIGNMENT

TO_RAW_SUBSTANCE_MATL_ASSIGNMENT: Link<RawSubstance, SpecAssignedMatlForKeyDate> = new Link('to_RawSubstanceMatlAssignment', RawSubstance, SpecAssignedMatlForKeyDate)

Static representation of the one-to-many navigation property toRawSubstanceMatlAssignment for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_RAW_SUBSTANCE_NEXT_STATUS

TO_RAW_SUBSTANCE_NEXT_STATUS: Link<RawSubstance, SpecStatusNextStatus> = new Link('to_RawSubstanceNextStatus', RawSubstance, SpecStatusNextStatus)

Static representation of the one-to-many navigation property toRawSubstanceNextStatus for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_RAW_SUBSTANCE_NTRNT_COMP

TO_RAW_SUBSTANCE_NTRNT_COMP: Link<RawSubstance, SpecValAssgmtInstanceWthComp> = new Link('to_RawSubstanceNtrntComp', RawSubstance, SpecValAssgmtInstanceWthComp)

Static representation of the one-to-many navigation property toRawSubstanceNtrntComp for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_RAW_SUBSTANCE_RELIGIOUS_COMP

TO_RAW_SUBSTANCE_RELIGIOUS_COMP: Link<RawSubstance, SpecValAssgmtInstanceWthComp> = new Link('to_RawSubstanceReligiousComp', RawSubstance, SpecValAssgmtInstanceWthComp)

Static representation of the one-to-many navigation property toRawSubstanceReligiousComp for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_RAW_SUBSTANCE_SCHEMA

TO_RAW_SUBSTANCE_SCHEMA: Link<RawSubstance, SpecStatusSchema> = new Link('to_RawSubstanceSchema', RawSubstance, SpecStatusSchema)

Static representation of the one-to-many navigation property toRawSubstanceSchema for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_RAW_SUBSTANCE_STATUS_ATTRIBUTES

TO_RAW_SUBSTANCE_STATUS_ATTRIBUTES: Link<RawSubstance, SpecStatusAttributes> = new Link('to_RawSubstanceStatusAttributes', RawSubstance, SpecStatusAttributes)

Static representation of the one-to-many navigation property toRawSubstanceStatusAttributes for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_RAW_SUBSTANCE_STD_COMP

TO_RAW_SUBSTANCE_STD_COMP: Link<RawSubstance, SpecValAssgmtInstanceWthComp> = new Link('to_RawSubstanceStdComp', RawSubstance, SpecValAssgmtInstanceWthComp)

Static representation of the one-to-many navigation property toRawSubstanceStdComp for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_RAW_SUBSTANCE_TOTAL_SOLID

TO_RAW_SUBSTANCE_TOTAL_SOLID: Link<RawSubstance, SpecCharByValueAssgmtInst> = new Link('to_RawSubstanceTotalSolid', RawSubstance, SpecCharByValueAssgmtInst)

Static representation of the one-to-many navigation property toRawSubstanceTotalSolid for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static _allFields

_allFields: Array<StringField<RawSubstance> | DateField<RawSubstance> | Link<RawSubstance, SpecValAssgmtInstanceWthComp> | Link<RawSubstance, SpecAuthorizationGroupText> | Link<RawSubstance, SpecCharByValueAssgmtInst> | Link<RawSubstance, SpecIdentifier> | Link<RawSubstance, SpecAssignedMatlForKeyDate> | Link<RawSubstance, SpecStatusNextStatus> | Link<RawSubstance, SpecStatusSchema> | Link<RawSubstance, SpecStatusAttributes>> = [RawSubstance.RAW_SUBSTANCE_INTERNAL_ID,RawSubstance.RAW_SUBSTANCE_TYPE,RawSubstance.SPECIFICATION_CATEGORY,RawSubstance.SPECIFICATION_NOTE,RawSubstance.SPECIFICATION_HEADER_STATUS,RawSubstance.SPECIFICATION_HDR_STS_SCHEMA,RawSubstance.RAW_SUBSTANCE,RawSubstance.RAW_SUBSTANCE_AUTHZN_GROUP,RawSubstance.RAW_SUBSTANCE_CREATION_DATE,RawSubstance.RAW_SUBSTANCE_CREATED_BY_USER,RawSubstance.RAW_SUBSTANCE_CREATED_BY_USER_NAME,RawSubstance.RAW_SUBSTANCE_CHANGE_DATE,RawSubstance.RAW_SUBSTANCE_CHANGED_BY_USER,RawSubstance.RAW_SUBSTANCE_CHANGED_BY_USER_NAME,RawSubstance.TO_RAW_SUBSTANCE_ALLERGEN_COMP,RawSubstance.TO_RAW_SUBSTANCE_AUTHZN_GROUP_TEXT,RawSubstance.TO_RAW_SUBSTANCE_COMPONENT_TYPE,RawSubstance.TO_RAW_SUBSTANCE_CONVERSION_FACTOR,RawSubstance.TO_RAW_SUBSTANCE_DENSITY,RawSubstance.TO_RAW_SUBSTANCE_DIET_COMP,RawSubstance.TO_RAW_SUBSTANCE_ESTIMATED_PRICE,RawSubstance.TO_RAW_SUBSTANCE_GMO_COMP,RawSubstance.TO_RAW_SUBSTANCE_IDENTIFIER,RawSubstance.TO_RAW_SUBSTANCE_MATL_ASSIGNMENT,RawSubstance.TO_RAW_SUBSTANCE_NEXT_STATUS,RawSubstance.TO_RAW_SUBSTANCE_NTRNT_COMP,RawSubstance.TO_RAW_SUBSTANCE_RELIGIOUS_COMP,RawSubstance.TO_RAW_SUBSTANCE_SCHEMA,RawSubstance.TO_RAW_SUBSTANCE_STATUS_ATTRIBUTES,RawSubstance.TO_RAW_SUBSTANCE_STD_COMP,RawSubstance.TO_RAW_SUBSTANCE_TOTAL_SOLID]

All fields of the RawSubstance entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/sap/API_RAWSUBSTANCE"

Default url path for the according service.

Static _entityName

_entityName: string = "A_RawSubstance"

Technical entity name for RawSubstance.

Static _keyFields

_keyFields: Array<Selectable<RawSubstance>> = [RawSubstance.RAW_SUBSTANCE_INTERNAL_ID]

All key fields of the RawSubstance entity.

Static _keys

_keys: any = RawSubstance._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

Mapping of all key field names to the respective static field property RawSubstance.

Static _serviceName

_serviceName: string = "API_RAWSUBSTANCE"
deprecated

Since v1.0.1 Use _defaultServicePath instead. Technical service name for RawSubstance.

Methods

Protected getCurrentMapKeys

  • getCurrentMapKeys(): Entity
  • Returns a map of all defined fields in entity to their current values.

    Returns Entity

    Entity with all defined entity fields

getCustomField

  • getCustomField(fieldName: string): any
  • Custom field value getter.

    Parameters

    • fieldName: string

      The name of the custom field

    Returns any

    The value of the corresponding custom field

getCustomFields

  • getCustomFields(): MapType<any>
  • Returns a map that contains all entity custom fields.

    Returns MapType<any>

    A map of all defined custom fields in the entity

getUpdatedCustomFields

  • getUpdatedCustomFields(): MapType<any>
  • Returns all updated custom field properties compared to the last known remote state.

    Returns MapType<any>

    A map containing all updated custom properties, with their new values

getUpdatedProperties

  • getUpdatedProperties(): Entity
  • Returns all changed properties compared to the last known remote state. The returned properties does not include custom fields. Use getUpdatedCustomFields, if updated custom fields are needed.

    Returns Entity

    Entity with all properties that changed

hasCustomField

  • hasCustomField(fieldName: string): boolean
  • Validates whether a custom field exists in the entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    Returns boolean

    A boolean value, that indicates whether a custom field is defined in entity

initializeCustomFields

  • initializeCustomFields(customFields: MapType<any>): this
  • Sets all retrieved custom fields in entity.

    Parameters

    • customFields: MapType<any>

      Extracted custom fields from a retrieved entity

    Returns this

    A boolean value, that indicates the existence of the field in entity

Protected isConflictingCustomField

  • isConflictingCustomField(customFieldName: string): boolean
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    Parameters

    • customFieldName: string

      Field name to check

    Returns boolean

    Boolean value that describes whether a field name can be defined as custom field

setCustomField

  • setCustomField(fieldName: string, value: any): this
  • Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    • value: any

      The value of the field

    Returns this

    The entity itself, to facilitate method chaining

setOrInitializeRemoteState

  • setOrInitializeRemoteState(state?: MapType<any>): this
  • Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests. This function should be called after initializeCustomFields, if custom fields are defined.

    Parameters

    • Optional state: MapType<any>

      State to be set as remote state

    Returns this

    The entity itself, to facilitate method chaining

setVersionIdentifier

  • setVersionIdentifier(etag: string): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string

      The returned ETag version of the entity

    Returns this

    The entity itself, to facilitate method chaining

toJSON

  • toJSON(): object
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    Returns object

    An object containing all instance variables + custom fields.

    • [key: string]: any

Static builder

  • Returns an entity builder to construct instances RawSubstance.

    Returns EntityBuilderType<RawSubstance, RawSubstanceType>

    A builder that constructs instances of entity type RawSubstance.

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity RawSubstance.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<RawSubstance>

    A builder that constructs instances of entity type RawSubstance.

Static Protected customFieldSelector

  • customFieldSelector<EntityT>(fieldName: string, entityConstructor: Constructable<EntityT>): CustomField<EntityT>
  • Type parameters

    • EntityT: Entity

    Parameters

    • fieldName: string
    • entityConstructor: Constructable<EntityT>

    Returns CustomField<EntityT>

Static Protected entityBuilder

  • entityBuilder<EntityT, JsonT>(entityConstructor: Constructable<EntityT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the RawSubstance entity type.

    Returns RawSubstanceRequestBuilder

    A RawSubstance request builder.