Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_PurchasingQuotaArrangement" of service "API_PUR_QUOTA_ARRANGEMENT_SRV". This service is part of the following communication scenarios: Purchasing Quota Arrangement Integration (SAP_COM_0166). See https://api.sap.com/api/API_PUR_QUOTA_ARRANGEMENT_SRV for more information.

Hierarchy

  • Entity
    • PurchasingQuotaArrangement

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 createdByUser

createdByUser: undefined | string

Name of Person Who Created Object. Maximum length: 12.

nullable

Optional creationDate

creationDate: Moment

Date on Which Record Was Created.

nullable

Optional lastChangeDateTime

lastChangeDateTime: Moment

UTC Time Stamp in Long Form (YYYYMMDDhhmmssmmmuuun). The UTC timestamp displays date and time according to UTC (Universal Coordinated Time). In order to convert local time into a UTC time stamp, which makes it easier to compare times, the local time must be converted according to your time zone. The ABAP command convert is available for this purpose.Even if the time zone that the conversion is based on can be redetermined from Customizing or master data, we still recommend that you save the time zone.The internal structure of the high-resolution UTC time stamp is logically organized in date and time sections in a packed decimal format (YYYYMMDDhhmmssmmmuuun), which depicts the year, month, day, hour,second, millisecond, microsecond and the first decimal of the nanoseconds. Please note that the hardware that is normally used does not fully support a resolution of 100 nanoseconds, which is available in the structure.See also GET TIME STAMPA UTC time stamp in short form is also available.

nullable

Optional material

material: undefined | string

Material Number. Alphanumeric key uniquely identifying the material. Maximum length: 40.

nullable

Optional materialBaseUnit

materialBaseUnit: undefined | string

Base Unit of Measure. Unit of measure in which stocks of the material are managed. The system converts all the quantities you enter in other units of measure (alternative units of measure) to the base unit of measure. You define the base unit of measure and also alternative units of measure and their conversion factors in the material master record.Since all data is updated in the base unit of measure, your entry is particularly important for the conversion of alternative units of measure. A quantity in the alternative unit of measure can only be shown precisely if its value can be shown with the decimal places available. To ensure this, please note the following:The base unit of measure is the unit satisfying the highest necessary requirement for precision.The conversion of alternative units of measure to the base unit should result in simple decimal fractions (not, for example, 1/3 = 0.333...).Inventory ManagementIn Inventory Management, the base unit of measure is the same as the stockkeeping unit.ServicesServices have units of measure of their own, including the following:Service unitUnit of measure at the higher item level. The precise quantities of the individual services are each at the detailed service line level.BlanketUnit of measure at service line level for services to be provided once only, and for which no precise quantities can or are to be specified. Maximum length: 3.

nullable

Optional minQtyForSpltQuota

minQtyForSpltQuota: BigNumber

Minimum Quantity for Splitting Quota. Specifies for the splitting quota the minimum quantity that a lot must have in order to be apportioned among several sources of supply in the planning run. If the lot is smaller than or equal to the minimum quantity, the system will proceed on the basis of the usual quota arrangement logic.Allocation by quota using splitting quotas is only carried out via a requirement planning run, subject to the following preconditions:Through the appropriate entry in the field Quota arrangement usage (on the MRP data screen 2 or Purchasing screen) it must have been specified that a quota arrangement is to be applied in the planning run.The indicator for the splitting quota must be set for the the lot-sizing procedure used for materials planning purposes in Customizing.

nullable

Optional plant

plant: undefined | string

Plant. Key uniquely identifying a plant. Maximum length: 4.

nullable

quotaArrangement

quotaArrangement: string

Number of quota arrangement. Uniquely identifies the quota arrangement. Maximum length: 10.

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

toPurgQuotaArrangementItem

toPurgQuotaArrangementItem: PurgQuotaArrangementItem[]

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

Optional userDescription

userDescription: undefined | string

Description of the Technical User Account. Maximum length: 80.

nullable

Optional validityEndDate

validityEndDate: Moment

Quota arrangement period valid until. Date until which the quota arrangement is valid.

nullable

Optional validityStartDate

validityStartDate: Moment

Quota arrangement period valid from. Date specifying when the quota arrangement becomes valid.

nullable

Static ALL_FIELDS

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

All fields selector.

Static CREATED_BY_USER

CREATED_BY_USER: StringField<PurchasingQuotaArrangement> = new StringField('CreatedByUser', PurchasingQuotaArrangement, 'Edm.String')

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

Static CREATION_DATE

CREATION_DATE: DateField<PurchasingQuotaArrangement> = new DateField('CreationDate', PurchasingQuotaArrangement, 'Edm.DateTime')

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

Static LAST_CHANGE_DATE_TIME

LAST_CHANGE_DATE_TIME: DateField<PurchasingQuotaArrangement> = new DateField('LastChangeDateTime', PurchasingQuotaArrangement, 'Edm.DateTimeOffset')

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

Static MATERIAL

MATERIAL: StringField<PurchasingQuotaArrangement> = new StringField('Material', PurchasingQuotaArrangement, '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 MATERIAL_BASE_UNIT

MATERIAL_BASE_UNIT: StringField<PurchasingQuotaArrangement> = new StringField('MaterialBaseUnit', PurchasingQuotaArrangement, 'Edm.String')

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

Static MIN_QTY_FOR_SPLT_QUOTA

MIN_QTY_FOR_SPLT_QUOTA: BigNumberField<PurchasingQuotaArrangement> = new BigNumberField('MinQtyForSpltQuota', PurchasingQuotaArrangement, 'Edm.Decimal')

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

Static PLANT

PLANT: StringField<PurchasingQuotaArrangement> = new StringField('Plant', PurchasingQuotaArrangement, 'Edm.String')

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

Static QUOTA_ARRANGEMENT

QUOTA_ARRANGEMENT: StringField<PurchasingQuotaArrangement> = new StringField('QuotaArrangement', PurchasingQuotaArrangement, 'Edm.String')

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

Static TO_PURG_QUOTA_ARRANGEMENT_ITEM

TO_PURG_QUOTA_ARRANGEMENT_ITEM: Link<PurchasingQuotaArrangement, PurgQuotaArrangementItem> = new Link('to_PurgQuotaArrangementItem', PurchasingQuotaArrangement, PurgQuotaArrangementItem)

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

Static USER_DESCRIPTION

USER_DESCRIPTION: StringField<PurchasingQuotaArrangement> = new StringField('UserDescription', PurchasingQuotaArrangement, 'Edm.String')

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

Static VALIDITY_END_DATE

VALIDITY_END_DATE: DateField<PurchasingQuotaArrangement> = new DateField('ValidityEndDate', PurchasingQuotaArrangement, 'Edm.DateTime')

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

Static VALIDITY_START_DATE

VALIDITY_START_DATE: DateField<PurchasingQuotaArrangement> = new DateField('ValidityStartDate', PurchasingQuotaArrangement, 'Edm.DateTime')

Static representation of the validityStartDate 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<PurchasingQuotaArrangement> | DateField<PurchasingQuotaArrangement> | BigNumberField<PurchasingQuotaArrangement> | Link<PurchasingQuotaArrangement, PurgQuotaArrangementItem>> = [PurchasingQuotaArrangement.QUOTA_ARRANGEMENT,PurchasingQuotaArrangement.MATERIAL,PurchasingQuotaArrangement.PLANT,PurchasingQuotaArrangement.VALIDITY_END_DATE,PurchasingQuotaArrangement.VALIDITY_START_DATE,PurchasingQuotaArrangement.CREATION_DATE,PurchasingQuotaArrangement.CREATED_BY_USER,PurchasingQuotaArrangement.MIN_QTY_FOR_SPLT_QUOTA,PurchasingQuotaArrangement.LAST_CHANGE_DATE_TIME,PurchasingQuotaArrangement.USER_DESCRIPTION,PurchasingQuotaArrangement.MATERIAL_BASE_UNIT,PurchasingQuotaArrangement.TO_PURG_QUOTA_ARRANGEMENT_ITEM]

All fields of the PurchasingQuotaArrangement entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_PurchasingQuotaArrangement"

Technical entity name for PurchasingQuotaArrangement.

Static _keyFields

_keyFields: Array<Selectable<PurchasingQuotaArrangement>> = [PurchasingQuotaArrangement.QUOTA_ARRANGEMENT]

All key fields of the PurchasingQuotaArrangement entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PUR_QUOTA_ARRANGEMENT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PurchasingQuotaArrangement>

    A builder that constructs instances of entity type PurchasingQuotaArrangement.

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

    Returns PurchasingQuotaArrangementRequestBuilder

    A PurchasingQuotaArrangement request builder.