Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_SpecValAssgmtInstanceWthComp" of service "API_REALSUBSTANCE". 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_REALSUBSTANCE for more information.

Hierarchy

  • Entity
    • SpecValAssgmtInstanceWthComp

Implements

Index

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 compSpecComponentType

compSpecComponentType: undefined | string

Component Type. Key specifying the component type. The component type identifies the type of ingredient in a composition. You define component types in a Customizing.Component types can be:Active ingredientsSolventsAdditivesStabilizersImpuritiesYou use the component type indicator to control whether you can assign specifications to value assignment items of the composition. For example, you can define that no specifications can be assigned to the component type "impurities" as the sum of all impurities is recorded in this field. Maximum length: 10.

nullable

Optional compSpecExceptionCode

compSpecExceptionCode: undefined | string

Exception Value of a Component. Specifies the exception value for the concentration specification of a component. If no concentration is specified for a component of a composition, you can specify an exception value. Maximum length: 2.

nullable

Optional compSpecLowerLimit

compSpecLowerLimit: BigNumber

Lower Limit of a Component Proportion. Value that specifies the lower limit of a component proportion (minimum proportion) in a composition. If you define a lower limit, you also need to record the unit and reference quantity.

nullable

Optional compSpecLowerLimitOperator

compSpecLowerLimitOperator: undefined | string

Operator for Lower Limit. Specifies the relationship between the actual value and the displayed value. Maximum length: 5.

nullable

Optional compSpecQuantity

compSpecQuantity: BigNumber

Target Value or Actual Value of a Component. Specifies the determined proportion of a component in a composition (target value or actual value). You must always specify a unit for a value, otherwise it is meaningless.

nullable

Optional compSpecSortSequence

compSpecSortSequence: undefined | string

Sort Order. You use the sort sequence to define the order in which information on a data record is displayed. In this way, you can display more important information first. Maximum length: 4.

nullable

Optional compSpecUnit

compSpecUnit: undefined | string

Unit for Quantity Specification. Specifies the unit for the quantity specified for the composition. You can enter the following exponents as units for the reference quantities W/W or VOL/VOL:% percent (or 1 per 100)PERMILLE per thousand (or 1 part per 1,000)PPM parts per million (or 1 part per 1,000,000)PPB parts per billion (or 1 part per 1,000,000,000)In the input help for the Unit field, the values available belong to the dimension that you set up using the Reference quantity field. Maximum length: 3.

nullable

Optional compSpecUpperLimit

compSpecUpperLimit: BigNumber

Upper limit of a component proportion. Value that specifies the upper limit of a component proportion (maximum proportion) in a composition. If you define an upper limit you also need to record a unit and reference quantity.

nullable

Optional compSpecUpperLimitOperator

compSpecUpperLimitOperator: undefined | string

Operator for Upper Limit. Specifies the relationship between the actual value and the displayed value. Maximum length: 5.

nullable

Optional componentSpecification

componentSpecification: undefined | 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

componentSpecificationIntId

componentSpecificationIntId: string

Reference to Specification Header of a Component. Maximum length: 20.

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

specValAssgmtType

specValAssgmtType: string

Value Assignment Type. Identifies the value assignment type. Maximum length: 30.

Optional specificationAuthznGroup

specificationAuthznGroup: undefined | string

Recipe Authorization Group. Maximum length: 10.

nullable

specificationInternalId

specificationInternalId: string

Sequential Number of Data Record. Specifies the numeric variable that identifies a data record internally in the system. Each table with master data contains this data element. The system uses this data element to assign a unique number to a data record when it is created. Maximum length: 20.

specificationRating

specificationRating: string

Rating. Key identifying a value assignment rating. Possible ratings are:MSDS material safety data sheetLABELING labelINTERN internal useEXTERN external informationCUSTOMER for customersSECRET confidentialThe rating together with the validity area make up the value assignment usage. Maximum length: 10.

Optional specificationType

specificationType: undefined | string

Specification Type. Maximum length: 10.

nullable

specificationValidityArea

specificationValidityArea: string

Validity Area. Specifies the validity area. Maximum length: 10.

toSubstanceIdentifier

toSubstanceIdentifier: SpecIdentifier[]

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

Static ALL_FIELDS

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

All fields selector.

Static COMPONENT_SPECIFICATION

COMPONENT_SPECIFICATION: StringField<SpecValAssgmtInstanceWthComp> = new StringField('ComponentSpecification', SpecValAssgmtInstanceWthComp, 'Edm.String')

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

Static COMPONENT_SPECIFICATION_INT_ID

COMPONENT_SPECIFICATION_INT_ID: StringField<SpecValAssgmtInstanceWthComp> = new StringField('ComponentSpecificationIntID', SpecValAssgmtInstanceWthComp, 'Edm.String')

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

Static COMP_SPEC_COMPONENT_TYPE

COMP_SPEC_COMPONENT_TYPE: StringField<SpecValAssgmtInstanceWthComp> = new StringField('CompSpecComponentType', SpecValAssgmtInstanceWthComp, 'Edm.String')

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

Static COMP_SPEC_EXCEPTION_CODE

COMP_SPEC_EXCEPTION_CODE: StringField<SpecValAssgmtInstanceWthComp> = new StringField('CompSpecExceptionCode', SpecValAssgmtInstanceWthComp, 'Edm.String')

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

Static COMP_SPEC_LOWER_LIMIT

COMP_SPEC_LOWER_LIMIT: BigNumberField<SpecValAssgmtInstanceWthComp> = new BigNumberField('CompSpecLowerLimit', SpecValAssgmtInstanceWthComp, 'Edm.Decimal')

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

Static COMP_SPEC_LOWER_LIMIT_OPERATOR

COMP_SPEC_LOWER_LIMIT_OPERATOR: StringField<SpecValAssgmtInstanceWthComp> = new StringField('CompSpecLowerLimitOperator', SpecValAssgmtInstanceWthComp, 'Edm.String')

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

Static COMP_SPEC_QUANTITY

COMP_SPEC_QUANTITY: BigNumberField<SpecValAssgmtInstanceWthComp> = new BigNumberField('CompSpecQuantity', SpecValAssgmtInstanceWthComp, 'Edm.Decimal')

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

Static COMP_SPEC_SORT_SEQUENCE

COMP_SPEC_SORT_SEQUENCE: StringField<SpecValAssgmtInstanceWthComp> = new StringField('CompSpecSortSequence', SpecValAssgmtInstanceWthComp, 'Edm.String')

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

Static COMP_SPEC_UNIT

COMP_SPEC_UNIT: StringField<SpecValAssgmtInstanceWthComp> = new StringField('CompSpecUnit', SpecValAssgmtInstanceWthComp, 'Edm.String')

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

Static COMP_SPEC_UPPER_LIMIT

COMP_SPEC_UPPER_LIMIT: BigNumberField<SpecValAssgmtInstanceWthComp> = new BigNumberField('CompSpecUpperLimit', SpecValAssgmtInstanceWthComp, 'Edm.Decimal')

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

Static COMP_SPEC_UPPER_LIMIT_OPERATOR

COMP_SPEC_UPPER_LIMIT_OPERATOR: StringField<SpecValAssgmtInstanceWthComp> = new StringField('CompSpecUpperLimitOperator', SpecValAssgmtInstanceWthComp, 'Edm.String')

Static representation of the compSpecUpperLimitOperator 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<SpecValAssgmtInstanceWthComp> = new StringField('SpecificationAuthznGroup', SpecValAssgmtInstanceWthComp, '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<SpecValAssgmtInstanceWthComp> = new StringField('SpecificationInternalID', SpecValAssgmtInstanceWthComp, '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_RATING

SPECIFICATION_RATING: StringField<SpecValAssgmtInstanceWthComp> = new StringField('SpecificationRating', SpecValAssgmtInstanceWthComp, 'Edm.String')

Static representation of the specificationRating 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<SpecValAssgmtInstanceWthComp> = new StringField('SpecificationType', SpecValAssgmtInstanceWthComp, '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 SPECIFICATION_VALIDITY_AREA

SPECIFICATION_VALIDITY_AREA: StringField<SpecValAssgmtInstanceWthComp> = new StringField('SpecificationValidityArea', SpecValAssgmtInstanceWthComp, 'Edm.String')

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

Static SPEC_VAL_ASSGMT_TYPE

SPEC_VAL_ASSGMT_TYPE: StringField<SpecValAssgmtInstanceWthComp> = new StringField('SpecValAssgmtType', SpecValAssgmtInstanceWthComp, 'Edm.String')

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

Static TO_SUBSTANCE_IDENTIFIER

TO_SUBSTANCE_IDENTIFIER: Link<SpecValAssgmtInstanceWthComp, SpecIdentifier> = new Link('to_SubstanceIdentifier', SpecValAssgmtInstanceWthComp, SpecIdentifier)

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

Static _allFields

_allFields: Array<StringField<SpecValAssgmtInstanceWthComp> | BigNumberField<SpecValAssgmtInstanceWthComp> | Link<SpecValAssgmtInstanceWthComp, SpecIdentifier>> = [SpecValAssgmtInstanceWthComp.SPECIFICATION_INTERNAL_ID,SpecValAssgmtInstanceWthComp.SPEC_VAL_ASSGMT_TYPE,SpecValAssgmtInstanceWthComp.SPECIFICATION_RATING,SpecValAssgmtInstanceWthComp.SPECIFICATION_VALIDITY_AREA,SpecValAssgmtInstanceWthComp.COMPONENT_SPECIFICATION_INT_ID,SpecValAssgmtInstanceWthComp.COMPONENT_SPECIFICATION,SpecValAssgmtInstanceWthComp.COMP_SPEC_COMPONENT_TYPE,SpecValAssgmtInstanceWthComp.COMP_SPEC_LOWER_LIMIT_OPERATOR,SpecValAssgmtInstanceWthComp.COMP_SPEC_LOWER_LIMIT,SpecValAssgmtInstanceWthComp.COMP_SPEC_UPPER_LIMIT_OPERATOR,SpecValAssgmtInstanceWthComp.COMP_SPEC_UPPER_LIMIT,SpecValAssgmtInstanceWthComp.COMP_SPEC_QUANTITY,SpecValAssgmtInstanceWthComp.COMP_SPEC_UNIT,SpecValAssgmtInstanceWthComp.COMP_SPEC_SORT_SEQUENCE,SpecValAssgmtInstanceWthComp.COMP_SPEC_EXCEPTION_CODE,SpecValAssgmtInstanceWthComp.SPECIFICATION_AUTHZN_GROUP,SpecValAssgmtInstanceWthComp.SPECIFICATION_TYPE,SpecValAssgmtInstanceWthComp.TO_SUBSTANCE_IDENTIFIER]

All fields of the SpecValAssgmtInstanceWthComp entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_SpecValAssgmtInstanceWthComp"

Technical entity name for SpecValAssgmtInstanceWthComp.

Static _keyFields

_keyFields: Array<Selectable<SpecValAssgmtInstanceWthComp>> = [SpecValAssgmtInstanceWthComp.SPECIFICATION_INTERNAL_ID, SpecValAssgmtInstanceWthComp.SPEC_VAL_ASSGMT_TYPE, SpecValAssgmtInstanceWthComp.SPECIFICATION_RATING, SpecValAssgmtInstanceWthComp.SPECIFICATION_VALIDITY_AREA, SpecValAssgmtInstanceWthComp.COMPONENT_SPECIFICATION_INT_ID]

All key fields of the SpecValAssgmtInstanceWthComp entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_REALSUBSTANCE"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SpecValAssgmtInstanceWthComp>

    A builder that constructs instances of entity type SpecValAssgmtInstanceWthComp.

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

    Returns SpecValAssgmtInstanceWthCompRequestBuilder

    A SpecValAssgmtInstanceWthComp request builder.