Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_RecipeProcessParamValue" 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
    • RecipeProcessParamValue

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

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 recipe

recipe: undefined | string

Recipe ID. Maximum length: 20.

nullable

Optional recipeLastChangeDateTime

recipeLastChangeDateTime: Moment

UTC Time Stamp in Short Form (YYYYMMDDhhmmss).

nullable

Optional recipeProcessActionPosNmbr

recipeProcessActionPosNmbr: undefined | string

ID of a Process Element. Maximum length: 4.

nullable

Optional recipeProcessElementUuid

recipeProcessElementUuid: undefined | string

Process Element GUID.

nullable

Optional recipeProcessEquipRqmtPosNmbr

recipeProcessEquipRqmtPosNmbr: undefined | string

Sequence Number. Maximum length: 4.

nullable

Optional recipeProcessEquipRqmtUuid

recipeProcessEquipRqmtUuid: undefined | string

Equipment Requirement GUID.

nullable

Optional recipeProcessOperationPosNmbr

recipeProcessOperationPosNmbr: undefined | string

ID of a Process Element. Maximum length: 4.

nullable

Optional recipeProcessParam

recipeProcessParam: undefined | string

Process Parameter Master Data - Legible Name / ID. Maximum length: 30.

nullable

Optional recipeProcessParamMaxVal

recipeProcessParamMaxVal: undefined | string

Maximum Value. Maximum length: 30.

nullable

Optional recipeProcessParamMinVal

recipeProcessParamMinVal: undefined | string

Minimum Value. Maximum length: 30.

nullable

Optional recipeProcessParamSqncNmbr

recipeProcessParamSqncNmbr: undefined | string

Sequence Number (Format NNNN). Maximum length: 4.

nullable

Optional recipeProcessParamTgtVal

recipeProcessParamTgtVal: undefined | string

Target Value. Maximum length: 30.

nullable

Optional recipeProcessParamUnit

recipeProcessParamUnit: undefined | string

Unit of Measure. Maximum length: 3.

nullable

Optional recipeProcessParamUuid

recipeProcessParamUuid: undefined | string

Process Parameter Master Data Key.

nullable

recipeProcessParamValUuid

recipeProcessParamValUuid: string

Process Parameter Value Key.

Optional recipeProcessStagePosNmbr

recipeProcessStagePosNmbr: undefined | string

ID of a Process Element. Maximum length: 4.

nullable

Optional recipeProcessUuid

recipeProcessUuid: undefined | string

Process GUID.

nullable

Optional recipeUuid

recipeUuid: undefined | string

Common Recipe 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

toRecProcParamValCharc

toRecProcParamValCharc: RecProcParamValCharc[]

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

toRecProcParamValClass

toRecProcParamValClass: RecProcParamValClass[]

One-to-many navigation property to the RecProcParamValClass 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.

toRecipeProcessEquipRqmt

toRecipeProcessEquipRqmt: RecipeProcessEquipRqmt

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

toRecipeProcessParam

toRecipeProcessParam: RecipeProcessParam

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

toRecipeProcessParamValueTxt

toRecipeProcessParamValueTxt: RecipeProcessParamValueTxt[]

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

Static ALL_FIELDS

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

All fields selector.

Static RECIPE

RECIPE: StringField<RecipeProcessParamValue> = new StringField('Recipe', RecipeProcessParamValue, 'Edm.String')

Static representation of the recipe 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<RecipeProcessParamValue> = new DateField('RecipeLastChangeDateTime', RecipeProcessParamValue, '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<RecipeProcessParamValue> = new StringField('RecipeProcessActionPosNmbr', RecipeProcessParamValue, '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_ELEMENT_UUID

RECIPE_PROCESS_ELEMENT_UUID: StringField<RecipeProcessParamValue> = new StringField('RecipeProcessElementUUID', RecipeProcessParamValue, '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_EQUIP_RQMT_POS_NMBR

RECIPE_PROCESS_EQUIP_RQMT_POS_NMBR: StringField<RecipeProcessParamValue> = new StringField('RecipeProcessEquipRqmtPosNmbr', RecipeProcessParamValue, 'Edm.String')

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

Static RECIPE_PROCESS_EQUIP_RQMT_UUID

RECIPE_PROCESS_EQUIP_RQMT_UUID: StringField<RecipeProcessParamValue> = new StringField('RecipeProcessEquipRqmtUUID', RecipeProcessParamValue, 'Edm.Guid')

Static representation of the recipeProcessEquipRqmtUuid 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<RecipeProcessParamValue> = new StringField('RecipeProcessOperationPosNmbr', RecipeProcessParamValue, '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_PARAM

RECIPE_PROCESS_PARAM: StringField<RecipeProcessParamValue> = new StringField('RecipeProcessParam', RecipeProcessParamValue, 'Edm.String')

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

Static RECIPE_PROCESS_PARAM_MAX_VAL

RECIPE_PROCESS_PARAM_MAX_VAL: StringField<RecipeProcessParamValue> = new StringField('RecipeProcessParamMaxVal', RecipeProcessParamValue, 'Edm.String')

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

Static RECIPE_PROCESS_PARAM_MIN_VAL

RECIPE_PROCESS_PARAM_MIN_VAL: StringField<RecipeProcessParamValue> = new StringField('RecipeProcessParamMinVal', RecipeProcessParamValue, 'Edm.String')

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

Static RECIPE_PROCESS_PARAM_SQNC_NMBR

RECIPE_PROCESS_PARAM_SQNC_NMBR: StringField<RecipeProcessParamValue> = new StringField('RecipeProcessParamSqncNmbr', RecipeProcessParamValue, 'Edm.String')

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

Static RECIPE_PROCESS_PARAM_TGT_VAL

RECIPE_PROCESS_PARAM_TGT_VAL: StringField<RecipeProcessParamValue> = new StringField('RecipeProcessParamTgtVal', RecipeProcessParamValue, 'Edm.String')

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

Static RECIPE_PROCESS_PARAM_UNIT

RECIPE_PROCESS_PARAM_UNIT: StringField<RecipeProcessParamValue> = new StringField('RecipeProcessParamUnit', RecipeProcessParamValue, 'Edm.String')

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

Static RECIPE_PROCESS_PARAM_UUID

RECIPE_PROCESS_PARAM_UUID: StringField<RecipeProcessParamValue> = new StringField('RecipeProcessParamUUID', RecipeProcessParamValue, 'Edm.Guid')

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

Static RECIPE_PROCESS_PARAM_VAL_UUID

RECIPE_PROCESS_PARAM_VAL_UUID: StringField<RecipeProcessParamValue> = new StringField('RecipeProcessParamValUUID', RecipeProcessParamValue, 'Edm.Guid')

Static representation of the recipeProcessParamValUuid 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<RecipeProcessParamValue> = new StringField('RecipeProcessStagePosNmbr', RecipeProcessParamValue, '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_UUID

RECIPE_PROCESS_UUID: StringField<RecipeProcessParamValue> = new StringField('RecipeProcessUUID', RecipeProcessParamValue, 'Edm.Guid')

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

Static RECIPE_UUID

RECIPE_UUID: StringField<RecipeProcessParamValue> = new StringField('RecipeUUID', RecipeProcessParamValue, 'Edm.Guid')

Static representation of the recipeUuid property 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<RecipeProcessParamValue, Recipe> = new OneToOneLink('to_Recipe', RecipeProcessParamValue, 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<RecipeProcessParamValue, RecipeProcessElement> = new OneToOneLink('to_RecipeProcessElement', RecipeProcessParamValue, 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 TO_RECIPE_PROCESS_EQUIP_RQMT

TO_RECIPE_PROCESS_EQUIP_RQMT: OneToOneLink<RecipeProcessParamValue, RecipeProcessEquipRqmt> = new OneToOneLink('to_RecipeProcessEquipRqmt', RecipeProcessParamValue, RecipeProcessEquipRqmt)

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

Static TO_RECIPE_PROCESS_PARAM

TO_RECIPE_PROCESS_PARAM: OneToOneLink<RecipeProcessParamValue, RecipeProcessParam> = new OneToOneLink('to_RecipeProcessParam', RecipeProcessParamValue, RecipeProcessParam)

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

Static TO_RECIPE_PROCESS_PARAM_VALUE_TXT

TO_RECIPE_PROCESS_PARAM_VALUE_TXT: Link<RecipeProcessParamValue, RecipeProcessParamValueTxt> = new Link('to_RecipeProcessParamValueTxt', RecipeProcessParamValue, RecipeProcessParamValueTxt)

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

Static TO_REC_PROC_PARAM_VAL_CHARC

TO_REC_PROC_PARAM_VAL_CHARC: Link<RecipeProcessParamValue, RecProcParamValCharc> = new Link('to_RecProcParamValCharc', RecipeProcessParamValue, RecProcParamValCharc)

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

Static TO_REC_PROC_PARAM_VAL_CLASS

TO_REC_PROC_PARAM_VAL_CLASS: Link<RecipeProcessParamValue, RecProcParamValClass> = new Link('to_RecProcParamValClass', RecipeProcessParamValue, RecProcParamValClass)

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

Static _allFields

_allFields: Array<StringField<RecipeProcessParamValue> | DateField<RecipeProcessParamValue> | OneToOneLink<RecipeProcessParamValue, Recipe> | OneToOneLink<RecipeProcessParamValue, RecipeProcessElement> | OneToOneLink<RecipeProcessParamValue, RecipeProcessEquipRqmt> | OneToOneLink<RecipeProcessParamValue, RecipeProcessParam> | Link<RecipeProcessParamValue, RecipeProcessParamValueTxt> | Link<RecipeProcessParamValue, RecProcParamValCharc> | Link<RecipeProcessParamValue, RecProcParamValClass>> = [RecipeProcessParamValue.RECIPE_PROCESS_PARAM_VAL_UUID,RecipeProcessParamValue.RECIPE_PROCESS_UUID,RecipeProcessParamValue.RECIPE_PROCESS_ELEMENT_UUID,RecipeProcessParamValue.RECIPE_PROCESS_PARAM_UUID,RecipeProcessParamValue.RECIPE_PROCESS_EQUIP_RQMT_UUID,RecipeProcessParamValue.RECIPE_PROCESS_PARAM_UNIT,RecipeProcessParamValue.RECIPE_PROCESS_PARAM_TGT_VAL,RecipeProcessParamValue.RECIPE_PROCESS_PARAM_MIN_VAL,RecipeProcessParamValue.RECIPE_PROCESS_PARAM_MAX_VAL,RecipeProcessParamValue.RECIPE_PROCESS_PARAM_SQNC_NMBR,RecipeProcessParamValue.RECIPE_LAST_CHANGE_DATE_TIME,RecipeProcessParamValue.RECIPE_UUID,RecipeProcessParamValue.RECIPE,RecipeProcessParamValue.RECIPE_PROCESS_PARAM,RecipeProcessParamValue.RECIPE_PROCESS_EQUIP_RQMT_POS_NMBR,RecipeProcessParamValue.RECIPE_PROCESS_STAGE_POS_NMBR,RecipeProcessParamValue.RECIPE_PROCESS_OPERATION_POS_NMBR,RecipeProcessParamValue.RECIPE_PROCESS_ACTION_POS_NMBR,RecipeProcessParamValue.TO_RECIPE,RecipeProcessParamValue.TO_RECIPE_PROCESS_ELEMENT,RecipeProcessParamValue.TO_RECIPE_PROCESS_EQUIP_RQMT,RecipeProcessParamValue.TO_RECIPE_PROCESS_PARAM,RecipeProcessParamValue.TO_RECIPE_PROCESS_PARAM_VALUE_TXT,RecipeProcessParamValue.TO_REC_PROC_PARAM_VAL_CHARC,RecipeProcessParamValue.TO_REC_PROC_PARAM_VAL_CLASS]

All fields of the RecipeProcessParamValue entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_RecipeProcessParamValue"

Technical entity name for RecipeProcessParamValue.

Static _keyFields

_keyFields: Array<Selectable<RecipeProcessParamValue>> = [RecipeProcessParamValue.RECIPE_PROCESS_PARAM_VAL_UUID]

All key fields of the RecipeProcessParamValue entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_RECIPE"
deprecated

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

Accessors

versionIdentifier

  • get versionIdentifier(): string
  • ETag version identifier accessor.

    Returns string

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

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 RecipeProcessParamValue.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<RecipeProcessParamValue>

    A builder that constructs instances of entity type RecipeProcessParamValue.

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 RecipeProcessParamValue entity type.

    Returns RecipeProcessParamValueRequestBuilder

    A RecipeProcessParamValue request builder.