Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_RecipeFormulaItem" of service "API_RECIPE". This service is part of the following communication scenarios: Product Lifecycle Management - Recipe Development Integration (SAP_COM_0136). See https://api.sap.com/api/API_RECIPE for more information.

Hierarchy

  • Entity
    • RecipeFormulaItem

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns RecipeFormulaItem

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 material

material: string

Material Number. Maximum length: 40.

nullable

Optional rcpFmlaItemComponentType

rcpFmlaItemComponentType: string

Component Type of Formula Item. Maximum length: 10.

nullable

Optional rcpFmlaItemExceptionCode

rcpFmlaItemExceptionCode: string

Exception Value. Maximum length: 2.

nullable

Optional rcpFmlaItemExplosionRecipeUuid

rcpFmlaItemExplosionRecipeUuid: string

Common Recipe GUID.

nullable

Optional rcpFmlaItemIsBalancingItem

rcpFmlaItemIsBalancingItem: string

Balancing Item. This data element indicates whether a formula item is a balancing item. A balancing item is relevant for evaporation (negative value) or absorption (positive value).For more information, see the Business Add-Ins under Logistics - General -> Product Lifecycle Management (PLM) -> PLM Web User Interface -> Recipe Development -> Recipe -> Calculations -> Business Add-Ins (BAdIs). Maximum length: 1.

nullable

Optional rcpFmlaItemIsSelectedForCalc

rcpFmlaItemIsSelectedForCalc: string

Calculate Quantity. Maximum length: 1.

nullable

Optional rcpFmlaItemLowerLimit

rcpFmlaItemLowerLimit: BigNumber

Quantity.

nullable

Optional rcpFmlaItemOverrunInPercent

rcpFmlaItemOverrunInPercent: BigNumber

Scrap Factor for Formula Item.

nullable

Optional rcpFmlaItemPosition

rcpFmlaItemPosition: string

Number of a Formula Item. Maximum length: 4.

nullable

Optional rcpFmlaItemQuantity

rcpFmlaItemQuantity: BigNumber

Quantity.

nullable

Optional rcpFmlaItemQuantityInKilogram

rcpFmlaItemQuantityInKilogram: BigNumber

Absolute Mass (As Float).

nullable

Optional rcpFmlaItemScrapInPercent

rcpFmlaItemScrapInPercent: BigNumber

Scrap Factor for Formula Item.

nullable

Optional rcpFmlaItemType

rcpFmlaItemType: string

Formula Item Type. Maximum length: 5.

nullable

Optional rcpFmlaItemUnit

rcpFmlaItemUnit: string

Unit of Measure. Maximum length: 3.

nullable

Optional rcpFmlaItemUpperLimit

rcpFmlaItemUpperLimit: BigNumber

Quantity.

nullable

rcpFmlaItemUuid

rcpFmlaItemUuid: string

Formula Item GUID.

Optional rcpFmlaUuid

rcpFmlaUuid: string

Formula GUID.

nullable

Optional recipeFmlaItemAltvIsUsed

recipeFmlaItemAltvIsUsed: string

Alternative Item Used for Calculation. Maximum length: 1.

nullable

Optional recipeLastChangeDateTime

recipeLastChangeDateTime: Moment

UTC Time Stamp in Short Form (YYYYMMDDhhmmss).

nullable

Optional recipeProcessActionPosNmbr

recipeProcessActionPosNmbr: string

ID of a Process Element. Maximum length: 4.

nullable

Optional recipeProcessActionUuid

recipeProcessActionUuid: string

Recipe Process Action Uuid.

nullable

Optional recipeProcessElementUuid

recipeProcessElementUuid: string

Process Element GUID.

nullable

Optional recipeProcessOperationPosNmbr

recipeProcessOperationPosNmbr: string

ID of a Process Element. Maximum length: 4.

nullable

Optional recipeProcessOperationUuid

recipeProcessOperationUuid: string

Recipe Process Operation Uuid.

nullable

Optional recipeProcessStagePosNmbr

recipeProcessStagePosNmbr: string

ID of a Process Element. Maximum length: 4.

nullable

Optional recipeProcessStageUuid

recipeProcessStageUuid: string

Process Element GUID.

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 specification

specification: string

Specification. Specifies the specification. First check if the specification field has an input help.Fields without input help:Enter a generic specification key.Choose Confirm.The SAP system checks whether your entry is permitted. For example, you cannot enter certain special characters, umlauts, or blank characters in the key. The SAP system lists all the suitable specification keys.Fields with input help:Enter a generic key.Choose Confirm.The SAP system searches for specifications as follows:First, it searches the identifiers of the category Number.If it does not find any corresponding identifier numbers, it searches the identifiers of the category Name.If it does not find any corresponding identifier names, it searches the specification keys.Example:Entry: 211The system searches for specifications that have an identifier with the number 211. Since hits are found, the system does not search for any other identifier names or specification keys.Examples of hits found:Specification key IU674828, CAS number 211-617-1, synonym diketeneSpecification key IU645625, CAS number 211-448-3, synonym 2-ethylhexanalEntry: ASThe system does not find any specifications that have an identifier with the number AS, so it searches the identifier names. Since hits are found, the system does not search for any other specification keys.Examples of hits found:Specification key IU7647145, CAS number 7647-14-5, synonym saltSpecification key IU7697372, CAS number 7697-37-2, synonym nitric acid. Maximum length: 12.

nullable

Optional specificationAuthznGroup

specificationAuthznGroup: string

Recipe Authorization Group. Maximum length: 10.

nullable

Optional specificationInternalId

specificationInternalId: string

Specification Key. Maximum length: 20.

nullable

Optional specificationType

specificationType: string

Specification Type. Maximum length: 10.

nullable

toExplosionRecipe

toExplosionRecipe: Recipe

One-to-one navigation property to the Recipe entity.

toRecipe

toRecipe: Recipe

One-to-one navigation property to the Recipe entity.

toRecipeProcessElement

toRecipeProcessElement: RecipeProcessElement

One-to-one navigation property to the RecipeProcessElement 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<RecipeFormulaItem> = new AllFields('*', RecipeFormulaItem)

All fields selector.

Static MATERIAL

MATERIAL: StringField<RecipeFormulaItem> = new StringField('Material', RecipeFormulaItem, 'Edm.String')

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

Static RCP_FMLA_ITEM_COMPONENT_TYPE

RCP_FMLA_ITEM_COMPONENT_TYPE: StringField<RecipeFormulaItem> = new StringField('RcpFmlaItemComponentType', RecipeFormulaItem, 'Edm.String')

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

Static RCP_FMLA_ITEM_EXCEPTION_CODE

RCP_FMLA_ITEM_EXCEPTION_CODE: StringField<RecipeFormulaItem> = new StringField('RcpFmlaItemExceptionCode', RecipeFormulaItem, 'Edm.String')

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

Static RCP_FMLA_ITEM_EXPLOSION_RECIPE_UUID

RCP_FMLA_ITEM_EXPLOSION_RECIPE_UUID: StringField<RecipeFormulaItem> = new StringField('RcpFmlaItemExplosionRecipeUUID', RecipeFormulaItem, 'Edm.Guid')

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

Static RCP_FMLA_ITEM_IS_BALANCING_ITEM

RCP_FMLA_ITEM_IS_BALANCING_ITEM: StringField<RecipeFormulaItem> = new StringField('RcpFmlaItemIsBalancingItem', RecipeFormulaItem, 'Edm.String')

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

Static RCP_FMLA_ITEM_IS_SELECTED_FOR_CALC

RCP_FMLA_ITEM_IS_SELECTED_FOR_CALC: StringField<RecipeFormulaItem> = new StringField('RcpFmlaItemIsSelectedForCalc', RecipeFormulaItem, 'Edm.String')

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

Static RCP_FMLA_ITEM_LOWER_LIMIT

RCP_FMLA_ITEM_LOWER_LIMIT: BigNumberField<RecipeFormulaItem> = new BigNumberField('RcpFmlaItemLowerLimit', RecipeFormulaItem, 'Edm.Decimal')

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

Static RCP_FMLA_ITEM_OVERRUN_IN_PERCENT

RCP_FMLA_ITEM_OVERRUN_IN_PERCENT: BigNumberField<RecipeFormulaItem> = new BigNumberField('RcpFmlaItemOverrunInPercent', RecipeFormulaItem, 'Edm.Decimal')

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

Static RCP_FMLA_ITEM_POSITION

RCP_FMLA_ITEM_POSITION: StringField<RecipeFormulaItem> = new StringField('RcpFmlaItemPosition', RecipeFormulaItem, 'Edm.String')

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

Static RCP_FMLA_ITEM_QUANTITY

RCP_FMLA_ITEM_QUANTITY: BigNumberField<RecipeFormulaItem> = new BigNumberField('RcpFmlaItemQuantity', RecipeFormulaItem, 'Edm.Decimal')

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

Static RCP_FMLA_ITEM_QUANTITY_IN_KILOGRAM

RCP_FMLA_ITEM_QUANTITY_IN_KILOGRAM: BigNumberField<RecipeFormulaItem> = new BigNumberField('RcpFmlaItemQuantityInKilogram', RecipeFormulaItem, 'Edm.Decimal')

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

Static RCP_FMLA_ITEM_SCRAP_IN_PERCENT

RCP_FMLA_ITEM_SCRAP_IN_PERCENT: BigNumberField<RecipeFormulaItem> = new BigNumberField('RcpFmlaItemScrapInPercent', RecipeFormulaItem, 'Edm.Decimal')

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

Static RCP_FMLA_ITEM_TYPE

RCP_FMLA_ITEM_TYPE: StringField<RecipeFormulaItem> = new StringField('RcpFmlaItemType', RecipeFormulaItem, 'Edm.String')

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

Static RCP_FMLA_ITEM_UNIT

RCP_FMLA_ITEM_UNIT: StringField<RecipeFormulaItem> = new StringField('RcpFmlaItemUnit', RecipeFormulaItem, 'Edm.String')

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

Static RCP_FMLA_ITEM_UPPER_LIMIT

RCP_FMLA_ITEM_UPPER_LIMIT: BigNumberField<RecipeFormulaItem> = new BigNumberField('RcpFmlaItemUpperLimit', RecipeFormulaItem, 'Edm.Decimal')

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

Static RCP_FMLA_ITEM_UUID

RCP_FMLA_ITEM_UUID: StringField<RecipeFormulaItem> = new StringField('RcpFmlaItemUUID', RecipeFormulaItem, 'Edm.Guid')

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

Static RCP_FMLA_UUID

RCP_FMLA_UUID: StringField<RecipeFormulaItem> = new StringField('RcpFmlaUUID', RecipeFormulaItem, 'Edm.Guid')

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

Static RECIPE_FMLA_ITEM_ALTV_IS_USED

RECIPE_FMLA_ITEM_ALTV_IS_USED: StringField<RecipeFormulaItem> = new StringField('RecipeFmlaItemAltvIsUsed', RecipeFormulaItem, 'Edm.String')

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

Static RECIPE_LAST_CHANGE_DATE_TIME

RECIPE_LAST_CHANGE_DATE_TIME: DateField<RecipeFormulaItem> = new DateField('RecipeLastChangeDateTime', RecipeFormulaItem, 'Edm.DateTimeOffset')

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

Static RECIPE_PROCESS_ACTION_POS_NMBR

RECIPE_PROCESS_ACTION_POS_NMBR: StringField<RecipeFormulaItem> = new StringField('RecipeProcessActionPosNmbr', RecipeFormulaItem, 'Edm.String')

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

Static RECIPE_PROCESS_ACTION_UUID

RECIPE_PROCESS_ACTION_UUID: StringField<RecipeFormulaItem> = new StringField('RecipeProcessActionUUID', RecipeFormulaItem, 'Edm.Guid')

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

Static RECIPE_PROCESS_ELEMENT_UUID

RECIPE_PROCESS_ELEMENT_UUID: StringField<RecipeFormulaItem> = new StringField('RecipeProcessElementUUID', RecipeFormulaItem, 'Edm.Guid')

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

Static RECIPE_PROCESS_OPERATION_POS_NMBR

RECIPE_PROCESS_OPERATION_POS_NMBR: StringField<RecipeFormulaItem> = new StringField('RecipeProcessOperationPosNmbr', RecipeFormulaItem, 'Edm.String')

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

Static RECIPE_PROCESS_OPERATION_UUID

RECIPE_PROCESS_OPERATION_UUID: StringField<RecipeFormulaItem> = new StringField('RecipeProcessOperationUUID', RecipeFormulaItem, 'Edm.Guid')

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

Static RECIPE_PROCESS_STAGE_POS_NMBR

RECIPE_PROCESS_STAGE_POS_NMBR: StringField<RecipeFormulaItem> = new StringField('RecipeProcessStagePosNmbr', RecipeFormulaItem, 'Edm.String')

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

Static RECIPE_PROCESS_STAGE_UUID

RECIPE_PROCESS_STAGE_UUID: StringField<RecipeFormulaItem> = new StringField('RecipeProcessStageUUID', RecipeFormulaItem, 'Edm.Guid')

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

Static SPECIFICATION

SPECIFICATION: StringField<RecipeFormulaItem> = new StringField('Specification', RecipeFormulaItem, 'Edm.String')

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

Static SPECIFICATION_AUTHZN_GROUP

SPECIFICATION_AUTHZN_GROUP: StringField<RecipeFormulaItem> = new StringField('SpecificationAuthznGroup', RecipeFormulaItem, 'Edm.String')

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

Static SPECIFICATION_INTERNAL_ID

SPECIFICATION_INTERNAL_ID: StringField<RecipeFormulaItem> = new StringField('SpecificationInternalID', RecipeFormulaItem, 'Edm.String')

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

Static SPECIFICATION_TYPE

SPECIFICATION_TYPE: StringField<RecipeFormulaItem> = new StringField('SpecificationType', RecipeFormulaItem, 'Edm.String')

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

Static TO_EXPLOSION_RECIPE

TO_EXPLOSION_RECIPE: OneToOneLink<RecipeFormulaItem, Recipe> = new OneToOneLink('to_ExplosionRecipe', RecipeFormulaItem, Recipe)

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

Static TO_RECIPE

TO_RECIPE: OneToOneLink<RecipeFormulaItem, Recipe> = new OneToOneLink('to_Recipe', RecipeFormulaItem, Recipe)

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

Static TO_RECIPE_PROCESS_ELEMENT

TO_RECIPE_PROCESS_ELEMENT: OneToOneLink<RecipeFormulaItem, RecipeProcessElement> = new OneToOneLink('to_RecipeProcessElement', RecipeFormulaItem, RecipeProcessElement)

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

Static _allFields

_allFields: Array<StringField<RecipeFormulaItem> | BigNumberField<RecipeFormulaItem> | DateField<RecipeFormulaItem> | OneToOneLink<RecipeFormulaItem, Recipe> | OneToOneLink<RecipeFormulaItem, RecipeProcessElement>> = [RecipeFormulaItem.RCP_FMLA_ITEM_UUID,RecipeFormulaItem.RCP_FMLA_UUID,RecipeFormulaItem.RCP_FMLA_ITEM_POSITION,RecipeFormulaItem.RCP_FMLA_ITEM_TYPE,RecipeFormulaItem.SPECIFICATION_INTERNAL_ID,RecipeFormulaItem.SPECIFICATION,RecipeFormulaItem.MATERIAL,RecipeFormulaItem.RCP_FMLA_ITEM_COMPONENT_TYPE,RecipeFormulaItem.RCP_FMLA_ITEM_LOWER_LIMIT,RecipeFormulaItem.RCP_FMLA_ITEM_UPPER_LIMIT,RecipeFormulaItem.RCP_FMLA_ITEM_QUANTITY,RecipeFormulaItem.RCP_FMLA_ITEM_UNIT,RecipeFormulaItem.RCP_FMLA_ITEM_EXCEPTION_CODE,RecipeFormulaItem.RCP_FMLA_ITEM_SCRAP_IN_PERCENT,RecipeFormulaItem.RCP_FMLA_ITEM_OVERRUN_IN_PERCENT,RecipeFormulaItem.RCP_FMLA_ITEM_QUANTITY_IN_KILOGRAM,RecipeFormulaItem.RCP_FMLA_ITEM_IS_SELECTED_FOR_CALC,RecipeFormulaItem.RCP_FMLA_ITEM_EXPLOSION_RECIPE_UUID,RecipeFormulaItem.RCP_FMLA_ITEM_IS_BALANCING_ITEM,RecipeFormulaItem.RECIPE_FMLA_ITEM_ALTV_IS_USED,RecipeFormulaItem.SPECIFICATION_TYPE,RecipeFormulaItem.SPECIFICATION_AUTHZN_GROUP,RecipeFormulaItem.RECIPE_PROCESS_ELEMENT_UUID,RecipeFormulaItem.RECIPE_PROCESS_STAGE_UUID,RecipeFormulaItem.RECIPE_PROCESS_OPERATION_UUID,RecipeFormulaItem.RECIPE_PROCESS_ACTION_UUID,RecipeFormulaItem.RECIPE_PROCESS_STAGE_POS_NMBR,RecipeFormulaItem.RECIPE_PROCESS_OPERATION_POS_NMBR,RecipeFormulaItem.RECIPE_PROCESS_ACTION_POS_NMBR,RecipeFormulaItem.RECIPE_LAST_CHANGE_DATE_TIME,RecipeFormulaItem.TO_RECIPE,RecipeFormulaItem.TO_EXPLOSION_RECIPE,RecipeFormulaItem.TO_RECIPE_PROCESS_ELEMENT]

All fields of the RecipeFormulaItem entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_RecipeFormulaItem"

Technical entity name for RecipeFormulaItem.

Static _keyFields

_keyFields: Array<Selectable<RecipeFormulaItem>> = [RecipeFormulaItem.RCP_FMLA_ITEM_UUID]

All key fields of the RecipeFormulaItem entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_RECIPE"
deprecated

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

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

Static customField

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<RecipeFormulaItem>

    A builder that constructs instances of entity type RecipeFormulaItem.

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, JsonT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT, JsonT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns RecipeFormulaItemRequestBuilder

    A RecipeFormulaItem request builder.