Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_SalesOrderScheduleLine" of service "API_SALES_ORDER_SRV". This service is part of the following communication scenarios: Sales Order Integration (SAP_COM_0109). See https://api.sap.com/api/API_SALES_ORDER_SRV for more information.

Hierarchy

  • Entity
    • SalesOrderScheduleLine

Implements

Index

Constructors

constructor

  • Returns SalesOrderScheduleLine

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 confdOrderQtyByMatlAvailCheck

confdOrderQtyByMatlAvailCheck: BigNumber

Confirmed Quantity. The item quantity that the system confirms for shipping after checking inventory availability. The confirmed quantity can differ from the order quantity (for example, insufficient stock is available to meet the customer's request). If the availability of inventory changes during delivery processing, the confirmed quantity can also differ from the delivered quantity that the customer actually receives.If you change the order quantity (for example, if you create new schedule lines for the item), the system updates the confirmed quantity (depending on availability).

nullable

Optional confirmedDeliveryDate

confirmedDeliveryDate: Moment

Confirmed Delivery Date.

nullable

Optional correctedQtyInOrderQtyUnit

correctedQtyInOrderQtyUnit: BigNumber

Corrected quantity in sales unit. Rounded quantity of the required quantity in the schedule line in the sales order. The system rounds the quantity using the rounding profiles from the customer-material info record or the material master record. The profile can be switched on for each customer.If you change the rounded quantity, the system automatically performs an availability check and/or delivery scheduling and updates the confirmed quantity. The rounded quantity is cumulated in the total order quantity of the item. The required order quantity remains as the original quantity (before rounding) in the schedule line.If the system does not round the quantity, the rounded quantity of the required order quantity in the schedule line is valid.

nullable

Optional delivBlockReasonForSchedLine

delivBlockReasonForSchedLine: string

Schedule Line Blocked for Delivery. Indicates if a schedule line for the item is blocked for delivery. Maximum length: 2.

nullable

Optional deliveredQtyInOrderQtyUnit

deliveredQtyInOrderQtyUnit: BigNumber

Delivered Quantity.

nullable

Optional openConfdDelivQtyInOrdQtyUnit

openConfdDelivQtyInOrdQtyUnit: BigNumber

Open Confirmed Delivery Quantity.

nullable

Optional orderQuantityUnit

orderQuantityUnit: string

Sales Unit. Unit of measure in which the material is sold. Maximum length: 3.

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

Optional requestedDeliveryDate

requestedDeliveryDate: Moment

Requested Delivery Date.

nullable

salesOrder

salesOrder: string

Sales Document. The number that uniquely identifies the sales document. Maximum length: 10.

salesOrderItem

salesOrderItem: string

Sales Document Item. The number that uniquely identifies the item in the sales document. Maximum length: 6.

scheduleLine

scheduleLine: string

Schedule Line Number. The number that uniquely identifies the schedule line in the sales document. When an item has more than one schedule line, the system automatically assigns a unique number to each line. The number is displayed in the details screens for schedule lines.The schedule line number serves internal purposes and does not, for example, determine the sequence of schedule lines in the overview screen. The schedule lines on the overview screen are sorted by date. Maximum length: 4.

Optional scheduleLineOrderQuantity

scheduleLineOrderQuantity: BigNumber

Order Quantity in Sales Units. Required order quantity in an individual schedule line. If you change the required order quantity in the schedule line, the system re-rounds the quantities, determines the rounded quantity, and re-runs the availability check based on the rounded quantity. The required order quantity remains as the orginal quantity (before rounding) in the schedule line.If the system does not round up the quantity, this means that the required order quantity matches the rounded quantity.

nullable

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

All fields selector.

Static CONFD_ORDER_QTY_BY_MATL_AVAIL_CHECK

CONFD_ORDER_QTY_BY_MATL_AVAIL_CHECK: BigNumberField<SalesOrderScheduleLine> = new BigNumberField('ConfdOrderQtyByMatlAvailCheck', SalesOrderScheduleLine, 'Edm.Decimal')

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

Static CONFIRMED_DELIVERY_DATE

CONFIRMED_DELIVERY_DATE: DateField<SalesOrderScheduleLine> = new DateField('ConfirmedDeliveryDate', SalesOrderScheduleLine, 'Edm.DateTime')

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

Static CORRECTED_QTY_IN_ORDER_QTY_UNIT

CORRECTED_QTY_IN_ORDER_QTY_UNIT: BigNumberField<SalesOrderScheduleLine> = new BigNumberField('CorrectedQtyInOrderQtyUnit', SalesOrderScheduleLine, 'Edm.Decimal')

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

Static DELIVERED_QTY_IN_ORDER_QTY_UNIT

DELIVERED_QTY_IN_ORDER_QTY_UNIT: BigNumberField<SalesOrderScheduleLine> = new BigNumberField('DeliveredQtyInOrderQtyUnit', SalesOrderScheduleLine, 'Edm.Decimal')

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

Static DELIV_BLOCK_REASON_FOR_SCHED_LINE

DELIV_BLOCK_REASON_FOR_SCHED_LINE: StringField<SalesOrderScheduleLine> = new StringField('DelivBlockReasonForSchedLine', SalesOrderScheduleLine, 'Edm.String')

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

Static OPEN_CONFD_DELIV_QTY_IN_ORD_QTY_UNIT

OPEN_CONFD_DELIV_QTY_IN_ORD_QTY_UNIT: BigNumberField<SalesOrderScheduleLine> = new BigNumberField('OpenConfdDelivQtyInOrdQtyUnit', SalesOrderScheduleLine, 'Edm.Decimal')

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

Static ORDER_QUANTITY_UNIT

ORDER_QUANTITY_UNIT: StringField<SalesOrderScheduleLine> = new StringField('OrderQuantityUnit', SalesOrderScheduleLine, 'Edm.String')

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

Static REQUESTED_DELIVERY_DATE

REQUESTED_DELIVERY_DATE: DateField<SalesOrderScheduleLine> = new DateField('RequestedDeliveryDate', SalesOrderScheduleLine, 'Edm.DateTime')

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

Static SALES_ORDER

SALES_ORDER: StringField<SalesOrderScheduleLine> = new StringField('SalesOrder', SalesOrderScheduleLine, 'Edm.String')

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

Static SALES_ORDER_ITEM

SALES_ORDER_ITEM: StringField<SalesOrderScheduleLine> = new StringField('SalesOrderItem', SalesOrderScheduleLine, 'Edm.String')

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

Static SCHEDULE_LINE

SCHEDULE_LINE: StringField<SalesOrderScheduleLine> = new StringField('ScheduleLine', SalesOrderScheduleLine, 'Edm.String')

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

Static SCHEDULE_LINE_ORDER_QUANTITY

SCHEDULE_LINE_ORDER_QUANTITY: BigNumberField<SalesOrderScheduleLine> = new BigNumberField('ScheduleLineOrderQuantity', SalesOrderScheduleLine, 'Edm.Decimal')

Static representation of the scheduleLineOrderQuantity 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<SalesOrderScheduleLine> | DateField<SalesOrderScheduleLine> | BigNumberField<SalesOrderScheduleLine>> = [SalesOrderScheduleLine.SALES_ORDER,SalesOrderScheduleLine.SALES_ORDER_ITEM,SalesOrderScheduleLine.SCHEDULE_LINE,SalesOrderScheduleLine.REQUESTED_DELIVERY_DATE,SalesOrderScheduleLine.CONFIRMED_DELIVERY_DATE,SalesOrderScheduleLine.ORDER_QUANTITY_UNIT,SalesOrderScheduleLine.SCHEDULE_LINE_ORDER_QUANTITY,SalesOrderScheduleLine.CONFD_ORDER_QTY_BY_MATL_AVAIL_CHECK,SalesOrderScheduleLine.DELIVERED_QTY_IN_ORDER_QTY_UNIT,SalesOrderScheduleLine.OPEN_CONFD_DELIV_QTY_IN_ORD_QTY_UNIT,SalesOrderScheduleLine.CORRECTED_QTY_IN_ORDER_QTY_UNIT,SalesOrderScheduleLine.DELIV_BLOCK_REASON_FOR_SCHED_LINE]

All fields of the SalesOrderScheduleLine entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_SalesOrderScheduleLine"

Technical entity name for SalesOrderScheduleLine.

Static _keyFields

_keyFields: Array<Selectable<SalesOrderScheduleLine>> = [SalesOrderScheduleLine.SALES_ORDER, SalesOrderScheduleLine.SALES_ORDER_ITEM, SalesOrderScheduleLine.SCHEDULE_LINE]

All key fields of the SalesOrderScheduleLine entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_SALES_ORDER_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SalesOrderScheduleLine>

    A builder that constructs instances of entity type SalesOrderScheduleLine.

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

    Returns SalesOrderScheduleLineRequestBuilder

    A SalesOrderScheduleLine request builder.