Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • Entity
    • RealSubstance

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns RealSubstance

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 realSubstance

realSubstance: undefined | string

Real Substance. Maximum length: 12.

nullable

Optional realSubstanceAuthznGroup

realSubstanceAuthznGroup: undefined | string

Description of Authorization Group. Maximum length: 10.

nullable

Optional realSubstanceChangeDate

realSubstanceChangeDate: Moment

Changed On.

nullable

Optional realSubstanceChangedByUser

realSubstanceChangedByUser: undefined | string

Last Changed By. Maximum length: 12.

nullable

Optional realSubstanceChangedByUserName

realSubstanceChangedByUserName: undefined | string

Specification Changed By Name. Maximum length: 80.

nullable

Optional realSubstanceCreatedByUser

realSubstanceCreatedByUser: undefined | string

Created By. Maximum length: 12.

nullable

Optional realSubstanceCreatedByUserName

realSubstanceCreatedByUserName: undefined | string

Specification Header Created By Name. Maximum length: 80.

nullable

Optional realSubstanceCreationDate

realSubstanceCreationDate: Moment

Created On.

nullable

realSubstanceInternalId

realSubstanceInternalId: string

Sequential Number of Data Record. Maximum length: 20.

Optional realSubstanceType

realSubstanceType: undefined | 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: undefined | string

Specification Category. Maximum length: 10.

nullable

Optional specificationHdrStsSchema

specificationHdrStsSchema: undefined | string

Status Scheme. Maximum length: 20.

nullable

Optional specificationHeaderStatus

specificationHeaderStatus: undefined | string

Status Identification. Maximum length: 20.

nullable

Optional specificationNote

specificationNote: undefined | string

Note. Maximum length: 60.

nullable

toRealSubstanceAllergenComp

toRealSubstanceAllergenComp: SpecValAssgmtInstanceWthComp[]

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

toRealSubstanceAuthznGroupText

toRealSubstanceAuthznGroupText: SpecAuthorizationGroupText[]

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

toRealSubstanceComponentType

toRealSubstanceComponentType: SpecCharByValueAssgmtInst[]

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

toRealSubstanceConversionFactor

toRealSubstanceConversionFactor: SpecCharByValueAssgmtInst[]

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

toRealSubstanceDensity

toRealSubstanceDensity: SpecCharByValueAssgmtInst[]

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

toRealSubstanceDietComp

toRealSubstanceDietComp: SpecValAssgmtInstanceWthComp[]

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

toRealSubstanceEstimatedPrice

toRealSubstanceEstimatedPrice: SpecCharByValueAssgmtInst[]

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

toRealSubstanceGmoComp

toRealSubstanceGmoComp: SpecValAssgmtInstanceWthComp[]

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

toRealSubstanceIdentifier

toRealSubstanceIdentifier: SpecIdentifier[]

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

toRealSubstanceIngredientComp

toRealSubstanceIngredientComp: SpecValAssgmtInstanceWthComp[]

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

toRealSubstanceMatlAssignment

toRealSubstanceMatlAssignment: SpecAssignedMatlForKeyDate[]

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

toRealSubstanceNextStatus

toRealSubstanceNextStatus: SpecStatusNextStatus[]

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

toRealSubstanceNtrntComp

toRealSubstanceNtrntComp: SpecValAssgmtInstanceWthComp[]

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

toRealSubstanceReligiousComp

toRealSubstanceReligiousComp: SpecValAssgmtInstanceWthComp[]

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

toRealSubstanceSchema

toRealSubstanceSchema: SpecStatusSchema[]

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

toRealSubstanceStatusAttributes

toRealSubstanceStatusAttributes: SpecStatusAttributes[]

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

toRealSubstanceStdComp

toRealSubstanceStdComp: SpecValAssgmtInstanceWthComp[]

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

toRealSubstanceTotalSolid

toRealSubstanceTotalSolid: 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<RealSubstance> = new AllFields('*', RealSubstance)

All fields selector.

Static REAL_SUBSTANCE

REAL_SUBSTANCE: StringField<RealSubstance> = new StringField('RealSubstance', RealSubstance, 'Edm.String')

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

Static REAL_SUBSTANCE_AUTHZN_GROUP

REAL_SUBSTANCE_AUTHZN_GROUP: StringField<RealSubstance> = new StringField('RealSubstanceAuthznGroup', RealSubstance, 'Edm.String')

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

Static REAL_SUBSTANCE_CHANGED_BY_USER

REAL_SUBSTANCE_CHANGED_BY_USER: StringField<RealSubstance> = new StringField('RealSubstanceChangedByUser', RealSubstance, 'Edm.String')

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

Static REAL_SUBSTANCE_CHANGED_BY_USER_NAME

REAL_SUBSTANCE_CHANGED_BY_USER_NAME: StringField<RealSubstance> = new StringField('RealSubstanceChangedByUserName', RealSubstance, 'Edm.String')

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

Static REAL_SUBSTANCE_CHANGE_DATE

REAL_SUBSTANCE_CHANGE_DATE: DateField<RealSubstance> = new DateField('RealSubstanceChangeDate', RealSubstance, 'Edm.DateTime')

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

Static REAL_SUBSTANCE_CREATED_BY_USER

REAL_SUBSTANCE_CREATED_BY_USER: StringField<RealSubstance> = new StringField('RealSubstanceCreatedByUser', RealSubstance, 'Edm.String')

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

Static REAL_SUBSTANCE_CREATED_BY_USER_NAME

REAL_SUBSTANCE_CREATED_BY_USER_NAME: StringField<RealSubstance> = new StringField('RealSubstanceCreatedByUserName', RealSubstance, 'Edm.String')

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

Static REAL_SUBSTANCE_CREATION_DATE

REAL_SUBSTANCE_CREATION_DATE: DateField<RealSubstance> = new DateField('RealSubstanceCreationDate', RealSubstance, 'Edm.DateTime')

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

Static REAL_SUBSTANCE_INTERNAL_ID

REAL_SUBSTANCE_INTERNAL_ID: StringField<RealSubstance> = new StringField('RealSubstanceInternalID', RealSubstance, 'Edm.String')

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

Static REAL_SUBSTANCE_TYPE

REAL_SUBSTANCE_TYPE: StringField<RealSubstance> = new StringField('RealSubstanceType', RealSubstance, 'Edm.String')

Static representation of the realSubstanceType 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<RealSubstance> = new StringField('SpecificationCategory', RealSubstance, '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<RealSubstance> = new StringField('SpecificationHdrStsSchema', RealSubstance, '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<RealSubstance> = new StringField('SpecificationHeaderStatus', RealSubstance, '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<RealSubstance> = new StringField('SpecificationNote', RealSubstance, '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_REAL_SUBSTANCE_ALLERGEN_COMP

TO_REAL_SUBSTANCE_ALLERGEN_COMP: Link<RealSubstance, SpecValAssgmtInstanceWthComp> = new Link('to_RealSubstanceAllergenComp', RealSubstance, SpecValAssgmtInstanceWthComp)

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

Static TO_REAL_SUBSTANCE_AUTHZN_GROUP_TEXT

TO_REAL_SUBSTANCE_AUTHZN_GROUP_TEXT: Link<RealSubstance, SpecAuthorizationGroupText> = new Link('to_RealSubstanceAuthznGroupText', RealSubstance, SpecAuthorizationGroupText)

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

Static TO_REAL_SUBSTANCE_COMPONENT_TYPE

TO_REAL_SUBSTANCE_COMPONENT_TYPE: Link<RealSubstance, SpecCharByValueAssgmtInst> = new Link('to_RealSubstanceComponentType', RealSubstance, SpecCharByValueAssgmtInst)

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

Static TO_REAL_SUBSTANCE_CONVERSION_FACTOR

TO_REAL_SUBSTANCE_CONVERSION_FACTOR: Link<RealSubstance, SpecCharByValueAssgmtInst> = new Link('to_RealSubstanceConversionFactor', RealSubstance, SpecCharByValueAssgmtInst)

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

Static TO_REAL_SUBSTANCE_DENSITY

TO_REAL_SUBSTANCE_DENSITY: Link<RealSubstance, SpecCharByValueAssgmtInst> = new Link('to_RealSubstanceDensity', RealSubstance, SpecCharByValueAssgmtInst)

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

Static TO_REAL_SUBSTANCE_DIET_COMP

TO_REAL_SUBSTANCE_DIET_COMP: Link<RealSubstance, SpecValAssgmtInstanceWthComp> = new Link('to_RealSubstanceDietComp', RealSubstance, SpecValAssgmtInstanceWthComp)

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

Static TO_REAL_SUBSTANCE_ESTIMATED_PRICE

TO_REAL_SUBSTANCE_ESTIMATED_PRICE: Link<RealSubstance, SpecCharByValueAssgmtInst> = new Link('to_RealSubstanceEstimatedPrice', RealSubstance, SpecCharByValueAssgmtInst)

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

Static TO_REAL_SUBSTANCE_GMO_COMP

TO_REAL_SUBSTANCE_GMO_COMP: Link<RealSubstance, SpecValAssgmtInstanceWthComp> = new Link('to_RealSubstanceGMOComp', RealSubstance, SpecValAssgmtInstanceWthComp)

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

Static TO_REAL_SUBSTANCE_IDENTIFIER

TO_REAL_SUBSTANCE_IDENTIFIER: Link<RealSubstance, SpecIdentifier> = new Link('to_RealSubstanceIdentifier', RealSubstance, SpecIdentifier)

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

Static TO_REAL_SUBSTANCE_INGREDIENT_COMP

TO_REAL_SUBSTANCE_INGREDIENT_COMP: Link<RealSubstance, SpecValAssgmtInstanceWthComp> = new Link('to_RealSubstanceIngredientComp', RealSubstance, SpecValAssgmtInstanceWthComp)

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

Static TO_REAL_SUBSTANCE_MATL_ASSIGNMENT

TO_REAL_SUBSTANCE_MATL_ASSIGNMENT: Link<RealSubstance, SpecAssignedMatlForKeyDate> = new Link('to_RealSubstanceMatlAssignment', RealSubstance, SpecAssignedMatlForKeyDate)

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

Static TO_REAL_SUBSTANCE_NEXT_STATUS

TO_REAL_SUBSTANCE_NEXT_STATUS: Link<RealSubstance, SpecStatusNextStatus> = new Link('to_RealSubstanceNextStatus', RealSubstance, SpecStatusNextStatus)

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

Static TO_REAL_SUBSTANCE_NTRNT_COMP

TO_REAL_SUBSTANCE_NTRNT_COMP: Link<RealSubstance, SpecValAssgmtInstanceWthComp> = new Link('to_RealSubstanceNtrntComp', RealSubstance, SpecValAssgmtInstanceWthComp)

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

Static TO_REAL_SUBSTANCE_RELIGIOUS_COMP

TO_REAL_SUBSTANCE_RELIGIOUS_COMP: Link<RealSubstance, SpecValAssgmtInstanceWthComp> = new Link('to_RealSubstanceReligiousComp', RealSubstance, SpecValAssgmtInstanceWthComp)

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

Static TO_REAL_SUBSTANCE_SCHEMA

TO_REAL_SUBSTANCE_SCHEMA: Link<RealSubstance, SpecStatusSchema> = new Link('to_RealSubstanceSchema', RealSubstance, SpecStatusSchema)

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

Static TO_REAL_SUBSTANCE_STATUS_ATTRIBUTES

TO_REAL_SUBSTANCE_STATUS_ATTRIBUTES: Link<RealSubstance, SpecStatusAttributes> = new Link('to_RealSubstanceStatusAttributes', RealSubstance, SpecStatusAttributes)

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

Static TO_REAL_SUBSTANCE_STD_COMP

TO_REAL_SUBSTANCE_STD_COMP: Link<RealSubstance, SpecValAssgmtInstanceWthComp> = new Link('to_RealSubstanceStdComp', RealSubstance, SpecValAssgmtInstanceWthComp)

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

Static TO_REAL_SUBSTANCE_TOTAL_SOLID

TO_REAL_SUBSTANCE_TOTAL_SOLID: Link<RealSubstance, SpecCharByValueAssgmtInst> = new Link('to_RealSubstanceTotalSolid', RealSubstance, SpecCharByValueAssgmtInst)

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

Static _allFields

_allFields: Array<StringField<RealSubstance> | DateField<RealSubstance> | Link<RealSubstance, SpecValAssgmtInstanceWthComp> | Link<RealSubstance, SpecAuthorizationGroupText> | Link<RealSubstance, SpecCharByValueAssgmtInst> | Link<RealSubstance, SpecIdentifier> | Link<RealSubstance, SpecAssignedMatlForKeyDate> | Link<RealSubstance, SpecStatusNextStatus> | Link<RealSubstance, SpecStatusSchema> | Link<RealSubstance, SpecStatusAttributes>> = [RealSubstance.REAL_SUBSTANCE_INTERNAL_ID,RealSubstance.REAL_SUBSTANCE_TYPE,RealSubstance.SPECIFICATION_CATEGORY,RealSubstance.SPECIFICATION_NOTE,RealSubstance.SPECIFICATION_HEADER_STATUS,RealSubstance.SPECIFICATION_HDR_STS_SCHEMA,RealSubstance.REAL_SUBSTANCE,RealSubstance.REAL_SUBSTANCE_AUTHZN_GROUP,RealSubstance.REAL_SUBSTANCE_CREATION_DATE,RealSubstance.REAL_SUBSTANCE_CREATED_BY_USER,RealSubstance.REAL_SUBSTANCE_CREATED_BY_USER_NAME,RealSubstance.REAL_SUBSTANCE_CHANGE_DATE,RealSubstance.REAL_SUBSTANCE_CHANGED_BY_USER,RealSubstance.REAL_SUBSTANCE_CHANGED_BY_USER_NAME,RealSubstance.TO_REAL_SUBSTANCE_ALLERGEN_COMP,RealSubstance.TO_REAL_SUBSTANCE_AUTHZN_GROUP_TEXT,RealSubstance.TO_REAL_SUBSTANCE_COMPONENT_TYPE,RealSubstance.TO_REAL_SUBSTANCE_CONVERSION_FACTOR,RealSubstance.TO_REAL_SUBSTANCE_DENSITY,RealSubstance.TO_REAL_SUBSTANCE_DIET_COMP,RealSubstance.TO_REAL_SUBSTANCE_ESTIMATED_PRICE,RealSubstance.TO_REAL_SUBSTANCE_GMO_COMP,RealSubstance.TO_REAL_SUBSTANCE_IDENTIFIER,RealSubstance.TO_REAL_SUBSTANCE_INGREDIENT_COMP,RealSubstance.TO_REAL_SUBSTANCE_MATL_ASSIGNMENT,RealSubstance.TO_REAL_SUBSTANCE_NEXT_STATUS,RealSubstance.TO_REAL_SUBSTANCE_NTRNT_COMP,RealSubstance.TO_REAL_SUBSTANCE_RELIGIOUS_COMP,RealSubstance.TO_REAL_SUBSTANCE_SCHEMA,RealSubstance.TO_REAL_SUBSTANCE_STATUS_ATTRIBUTES,RealSubstance.TO_REAL_SUBSTANCE_STD_COMP,RealSubstance.TO_REAL_SUBSTANCE_TOTAL_SOLID]

All fields of the RealSubstance entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_RealSubstance"

Technical entity name for RealSubstance.

Static _keyFields

_keyFields: Array<Selectable<RealSubstance>> = [RealSubstance.REAL_SUBSTANCE_INTERNAL_ID]

All key fields of the RealSubstance entity.

Static _keys

_keys: object = RealSubstance._keyFields.reduce((acc: { [keys: string]: Selectable<RealSubstance> }, field: Selectable<RealSubstance>) => {acc[field.fieldName] = field;return acc;}, {})

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

Type declaration

Static _serviceName

_serviceName: string = "API_REALSUBSTANCE"
deprecated

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

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.

    deprecated

    Since 1.12.0. Will be removed in version 2.0.

    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 | undefined): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string | undefined

      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

Static customField

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<RealSubstance>

    A builder that constructs instances of entity type RealSubstance.

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, EntityTypeForceMandatoryT>(entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>): EntityBuilderType<EntityT, EntityTypeForceMandatoryT>
  • Type parameters

    • EntityT: Entity

    • EntityTypeForceMandatoryT

    Parameters

    • entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>

    Returns EntityBuilderType<EntityT, EntityTypeForceMandatoryT>

Static requestBuilder

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

    Returns RealSubstanceRequestBuilder

    A RealSubstance request builder.