Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_PurgPrcgCndnRecordScale" of service "API_PURGPRCGCONDITIONRECORD_SRV". This service is part of the following communication scenarios: Pricing Data Integration (SAP_COM_0294). See https://api.sap.com/api/API_PURGPRCGCONDITIONRECORD_SRV for more information.

Hierarchy

  • Entity
    • PurgPrcgCndnRecordScale

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 conditionRateValue

conditionRateValue: BigNumber

Condition Amount or Percentage. Determines how the system calculates prices using this condition. Depending on the condition type, it can be a fixed amount or a percentage. If the condition includes a pricing scale, the condition amount or percentage displays the first line of the scale. The following examples illustrate how you can use the condition amount or percentage in different condition types:If you create a condition that includes prices (for example, prices for a material), you enter an amount.If you create a condition based on percentage discounts or surcharges (for example, a customer-specific discount), you enter the value of a percentage. If the condition is a discount, the system automatically enters a minus sign behind the amount and a percent sign in the Condition Unit field.

nullable

Optional conditionRateValueUnit

conditionRateValueUnit: string

Condition unit (currency or percentage). The unit that determines whether the condition for a material is based on a percentage or on an amount in a particular currency. The use of the condition unit depends on the condition type (for example, whether the condition is a material price or a customer discount). The following examples illustrate what you can do when using different condition types.If you create a condition that includes prices (for example, prices for a material), you enter the currency that applies to the condition (for example, "USD" for US dollars)If you are creating a condition based on percentage discounts or surcharges (for example, a customer-specific discount), you cannot enter a value in the Condition unit field. Instead, the system automatically enters a percent sign as the condition unit when you enter a value in the Condition Amount field. Maximum length: 5.

nullable

conditionRecord

conditionRecord: string

Number of the Condition Record. Number that uniquely identifies a condition record. The system uses the condition record number to store and retrieve information during processing (pricing, for example). Maximum length: 10.

Optional conditionScaleAmount

conditionScaleAmount: BigNumber

Scale value. A value that is part of a pricing scale. The value is an amount in a particular currency.

nullable

Optional conditionScaleAmountCurrency

conditionScaleAmountCurrency: string

Scale Currency. Specifies a currency for a pricing scale in a condition record. If a pricing scale is based on a value instead of a quantity, you can specify a currency for the value. In the standard version of the SAP System, this field is only relevant in condition records for the following discounts:Price groupPrice group/Material pricing groupYou apply a price group discount to customers in a particular foreign country. When you create a condition record for this discount and enter values in the pricing scale, you can also enter the corresponding foreign currency. During pricing, the system then calculates discounts based on scale values in the foreign currency. The discount amount is then converted into the currency you are using in the sales document.After you enter a currency in this field and save the condition record, you cannot change the currency without deleting the record and creating it again. Maximum length: 5.

nullable

conditionScaleLine

conditionScaleLine: string

Current number of the line scale. Identifies the sequence of lines within a scale. Maximum length: 4.

Optional conditionScaleQuantity

conditionScaleQuantity: BigNumber

Condition scale quantity. Scale quantity (for example, number of pieces) to which a scale refers.

nullable

Optional conditionScaleQuantityUnit

conditionScaleQuantityUnit: string

Condition Scale Unit of Measure. Unit of measure to which the quantity scale refers. Maximum length: 3.

nullable

conditionSequentialNumber

conditionSequentialNumber: string

Sequential number of the condition. The sequential number that uniquely identifies the condition if a condition supplement exists. If you have assigned a condition supplement to the condition, the system automatically assigns the number. Maximum length: 2.

Optional eTag

eTag: string

E Tag. Maximum length: 40.

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

toPurgPrcgCndnRecdSuplmnt

toPurgPrcgCndnRecdSuplmnt: PurgPrcgCndnRecdSuplmnt

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

toPurgPrcgConditionRecord

toPurgPrcgConditionRecord: PurgPrcgConditionRecord

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

All fields selector.

Static CONDITION_RATE_VALUE

CONDITION_RATE_VALUE: BigNumberField<PurgPrcgCndnRecordScale> = new BigNumberField('ConditionRateValue', PurgPrcgCndnRecordScale, 'Edm.Decimal')

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

Static CONDITION_RATE_VALUE_UNIT

CONDITION_RATE_VALUE_UNIT: StringField<PurgPrcgCndnRecordScale> = new StringField('ConditionRateValueUnit', PurgPrcgCndnRecordScale, 'Edm.String')

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

Static CONDITION_RECORD

CONDITION_RECORD: StringField<PurgPrcgCndnRecordScale> = new StringField('ConditionRecord', PurgPrcgCndnRecordScale, 'Edm.String')

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

Static CONDITION_SCALE_AMOUNT

CONDITION_SCALE_AMOUNT: BigNumberField<PurgPrcgCndnRecordScale> = new BigNumberField('ConditionScaleAmount', PurgPrcgCndnRecordScale, 'Edm.Decimal')

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

Static CONDITION_SCALE_AMOUNT_CURRENCY

CONDITION_SCALE_AMOUNT_CURRENCY: StringField<PurgPrcgCndnRecordScale> = new StringField('ConditionScaleAmountCurrency', PurgPrcgCndnRecordScale, 'Edm.String')

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

Static CONDITION_SCALE_LINE

CONDITION_SCALE_LINE: StringField<PurgPrcgCndnRecordScale> = new StringField('ConditionScaleLine', PurgPrcgCndnRecordScale, 'Edm.String')

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

Static CONDITION_SCALE_QUANTITY

CONDITION_SCALE_QUANTITY: BigNumberField<PurgPrcgCndnRecordScale> = new BigNumberField('ConditionScaleQuantity', PurgPrcgCndnRecordScale, 'Edm.Decimal')

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

Static CONDITION_SCALE_QUANTITY_UNIT

CONDITION_SCALE_QUANTITY_UNIT: StringField<PurgPrcgCndnRecordScale> = new StringField('ConditionScaleQuantityUnit', PurgPrcgCndnRecordScale, 'Edm.String')

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

Static CONDITION_SEQUENTIAL_NUMBER

CONDITION_SEQUENTIAL_NUMBER: StringField<PurgPrcgCndnRecordScale> = new StringField('ConditionSequentialNumber', PurgPrcgCndnRecordScale, 'Edm.String')

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

Static E_TAG

E_TAG: StringField<PurgPrcgCndnRecordScale> = new StringField('ETag', PurgPrcgCndnRecordScale, 'Edm.String')

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

Static TO_PURG_PRCG_CNDN_RECD_SUPLMNT

TO_PURG_PRCG_CNDN_RECD_SUPLMNT: OneToOneLink<PurgPrcgCndnRecordScale, PurgPrcgCndnRecdSuplmnt> = new OneToOneLink('to_PurgPrcgCndnRecdSuplmnt', PurgPrcgCndnRecordScale, PurgPrcgCndnRecdSuplmnt)

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

Static TO_PURG_PRCG_CONDITION_RECORD

TO_PURG_PRCG_CONDITION_RECORD: OneToOneLink<PurgPrcgCndnRecordScale, PurgPrcgConditionRecord> = new OneToOneLink('to_PurgPrcgConditionRecord', PurgPrcgCndnRecordScale, PurgPrcgConditionRecord)

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

Static _allFields

_allFields: Array<StringField<PurgPrcgCndnRecordScale> | BigNumberField<PurgPrcgCndnRecordScale> | OneToOneLink<PurgPrcgCndnRecordScale, PurgPrcgCndnRecdSuplmnt> | OneToOneLink<PurgPrcgCndnRecordScale, PurgPrcgConditionRecord>> = [PurgPrcgCndnRecordScale.CONDITION_RECORD,PurgPrcgCndnRecordScale.CONDITION_SEQUENTIAL_NUMBER,PurgPrcgCndnRecordScale.CONDITION_SCALE_LINE,PurgPrcgCndnRecordScale.CONDITION_SCALE_QUANTITY,PurgPrcgCndnRecordScale.CONDITION_SCALE_QUANTITY_UNIT,PurgPrcgCndnRecordScale.CONDITION_SCALE_AMOUNT,PurgPrcgCndnRecordScale.CONDITION_SCALE_AMOUNT_CURRENCY,PurgPrcgCndnRecordScale.CONDITION_RATE_VALUE,PurgPrcgCndnRecordScale.CONDITION_RATE_VALUE_UNIT,PurgPrcgCndnRecordScale.E_TAG,PurgPrcgCndnRecordScale.TO_PURG_PRCG_CNDN_RECD_SUPLMNT,PurgPrcgCndnRecordScale.TO_PURG_PRCG_CONDITION_RECORD]

All fields of the PurgPrcgCndnRecordScale entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_PurgPrcgCndnRecordScale"

Technical entity name for PurgPrcgCndnRecordScale.

Static _keyFields

_keyFields: Array<Selectable<PurgPrcgCndnRecordScale>> = [PurgPrcgCndnRecordScale.CONDITION_RECORD, PurgPrcgCndnRecordScale.CONDITION_SEQUENTIAL_NUMBER, PurgPrcgCndnRecordScale.CONDITION_SCALE_LINE]

All key fields of the PurgPrcgCndnRecordScale entity.

Static _keys

_keys: any = PurgPrcgCndnRecordScale._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

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

Static _serviceName

_serviceName: string = "API_PURGPRCGCONDITIONRECORD_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PurgPrcgCndnRecordScale>

    A builder that constructs instances of entity type PurgPrcgCndnRecordScale.

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

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns PurgPrcgCndnRecordScaleRequestBuilder

    A PurgPrcgCndnRecordScale request builder.