Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_RecipeProcessParam" 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
    • RecipeProcessParam

Implements

Index

Constructors

constructor

  • Returns RecipeProcessParam

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 recipeProcessParam

recipeProcessParam: undefined | string

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

nullable

Optional recipeProcessParamClass

recipeProcessParamClass: undefined | string

Class ID for Classification. Maximum length: 18.

nullable

Optional recipeProcessParamDecPlaces

recipeProcessParamDecPlaces: undefined | string

Decimal Places for Process Parameter Values. Maximum length: 2.

nullable

Optional recipeProcessParamGroup

recipeProcessParamGroup: undefined | string

Process Parameter Group ID. Maximum length: 20.

nullable

Optional recipeProcessParamIsDeleted

recipeProcessParamIsDeleted: undefined | false | true

Process Parameter Deleted.

nullable

Optional recipeProcessParamIsObsolete

recipeProcessParamIsObsolete: undefined | false | true

Obsolete.

nullable

Optional recipeProcessParamMaxVal

recipeProcessParamMaxVal: undefined | string

Maximum Value. Maximum length: 30.

nullable

Optional recipeProcessParamMaxValIsFxd

recipeProcessParamMaxValIsFxd: undefined | false | true

Value Must Not Be Changed.

nullable

Optional recipeProcessParamMinVal

recipeProcessParamMinVal: undefined | string

Minimum Value. Maximum length: 30.

nullable

Optional recipeProcessParamMinValIsFxd

recipeProcessParamMinValIsFxd: undefined | false | true

Value Must Not Be Changed.

nullable

Optional recipeProcessParamTgtVal

recipeProcessParamTgtVal: undefined | string

Target Value. Maximum length: 30.

nullable

Optional recipeProcessParamTgtValIsFxd

recipeProcessParamTgtValIsFxd: undefined | false | true

Value Must Not Be Changed.

nullable

Optional recipeProcessParamUnit

recipeProcessParamUnit: undefined | string

Unit of Measure. Maximum length: 3.

nullable

Optional recipeProcessParamUnitIsFxd

recipeProcessParamUnitIsFxd: undefined | false | true

Value Must Not Be Changed.

nullable

recipeProcessParamUuid

recipeProcessParamUuid: string

Process Parameter Master Data Key.

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

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

All fields selector.

Static RECIPE_PROCESS_PARAM

RECIPE_PROCESS_PARAM: StringField<RecipeProcessParam> = new StringField('RecipeProcessParam', RecipeProcessParam, '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_CLASS

RECIPE_PROCESS_PARAM_CLASS: StringField<RecipeProcessParam> = new StringField('RecipeProcessParamClass', RecipeProcessParam, 'Edm.String')

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

Static RECIPE_PROCESS_PARAM_DEC_PLACES

RECIPE_PROCESS_PARAM_DEC_PLACES: StringField<RecipeProcessParam> = new StringField('RecipeProcessParamDecPlaces', RecipeProcessParam, 'Edm.String')

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

Static RECIPE_PROCESS_PARAM_GROUP

RECIPE_PROCESS_PARAM_GROUP: StringField<RecipeProcessParam> = new StringField('RecipeProcessParamGroup', RecipeProcessParam, 'Edm.String')

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

Static RECIPE_PROCESS_PARAM_IS_DELETED

RECIPE_PROCESS_PARAM_IS_DELETED: BooleanField<RecipeProcessParam> = new BooleanField('RecipeProcessParamIsDeleted', RecipeProcessParam, 'Edm.Boolean')

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

Static RECIPE_PROCESS_PARAM_IS_OBSOLETE

RECIPE_PROCESS_PARAM_IS_OBSOLETE: BooleanField<RecipeProcessParam> = new BooleanField('RecipeProcessParamIsObsolete', RecipeProcessParam, 'Edm.Boolean')

Static representation of the recipeProcessParamIsObsolete 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<RecipeProcessParam> = new StringField('RecipeProcessParamMaxVal', RecipeProcessParam, '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_MAX_VAL_IS_FXD

RECIPE_PROCESS_PARAM_MAX_VAL_IS_FXD: BooleanField<RecipeProcessParam> = new BooleanField('RecipeProcessParamMaxValIsFxd', RecipeProcessParam, 'Edm.Boolean')

Static representation of the recipeProcessParamMaxValIsFxd 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<RecipeProcessParam> = new StringField('RecipeProcessParamMinVal', RecipeProcessParam, '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_MIN_VAL_IS_FXD

RECIPE_PROCESS_PARAM_MIN_VAL_IS_FXD: BooleanField<RecipeProcessParam> = new BooleanField('RecipeProcessParamMinValIsFxd', RecipeProcessParam, 'Edm.Boolean')

Static representation of the recipeProcessParamMinValIsFxd 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<RecipeProcessParam> = new StringField('RecipeProcessParamTgtVal', RecipeProcessParam, '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_TGT_VAL_IS_FXD

RECIPE_PROCESS_PARAM_TGT_VAL_IS_FXD: BooleanField<RecipeProcessParam> = new BooleanField('RecipeProcessParamTgtValIsFxd', RecipeProcessParam, 'Edm.Boolean')

Static representation of the recipeProcessParamTgtValIsFxd 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<RecipeProcessParam> = new StringField('RecipeProcessParamUnit', RecipeProcessParam, '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_UNIT_IS_FXD

RECIPE_PROCESS_PARAM_UNIT_IS_FXD: BooleanField<RecipeProcessParam> = new BooleanField('RecipeProcessParamUnitIsFxd', RecipeProcessParam, 'Edm.Boolean')

Static representation of the recipeProcessParamUnitIsFxd 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<RecipeProcessParam> = new StringField('RecipeProcessParamUUID', RecipeProcessParam, '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 _allFields

_allFields: Array<StringField<RecipeProcessParam> | BooleanField<RecipeProcessParam>> = [RecipeProcessParam.RECIPE_PROCESS_PARAM_UUID,RecipeProcessParam.RECIPE_PROCESS_PARAM,RecipeProcessParam.RECIPE_PROCESS_PARAM_UNIT,RecipeProcessParam.RECIPE_PROCESS_PARAM_UNIT_IS_FXD,RecipeProcessParam.RECIPE_PROCESS_PARAM_TGT_VAL,RecipeProcessParam.RECIPE_PROCESS_PARAM_TGT_VAL_IS_FXD,RecipeProcessParam.RECIPE_PROCESS_PARAM_MIN_VAL,RecipeProcessParam.RECIPE_PROCESS_PARAM_MIN_VAL_IS_FXD,RecipeProcessParam.RECIPE_PROCESS_PARAM_MAX_VAL,RecipeProcessParam.RECIPE_PROCESS_PARAM_MAX_VAL_IS_FXD,RecipeProcessParam.RECIPE_PROCESS_PARAM_DEC_PLACES,RecipeProcessParam.RECIPE_PROCESS_PARAM_GROUP,RecipeProcessParam.RECIPE_PROCESS_PARAM_CLASS,RecipeProcessParam.RECIPE_PROCESS_PARAM_IS_OBSOLETE,RecipeProcessParam.RECIPE_PROCESS_PARAM_IS_DELETED]

All fields of the RecipeProcessParam entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_RecipeProcessParam"

Technical entity name for RecipeProcessParam.

Static _keyFields

_keyFields: Array<Selectable<RecipeProcessParam>> = [RecipeProcessParam.RECIPE_PROCESS_PARAM_UUID]

All key fields of the RecipeProcessParam entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_RECIPE"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<RecipeProcessParam>

    A builder that constructs instances of entity type RecipeProcessParam.

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

    Returns RecipeProcessParamRequestBuilder

    A RecipeProcessParam request builder.