Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_PurchaseOrderScheduleLine" of service "API_PURCHASEORDER_PROCESS_SRV". This service is part of the following communication scenarios: Distributed Manufacturing Integration (SAP_COM_0077), Purchase Order Integration (SAP_COM_0053). See https://api.sap.com/api/API_PURCHASEORDER_PROCESS_SRV for more information.

Hierarchy

  • Entity
    • PurchaseOrderScheduleLine

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 delivDateCategory

delivDateCategory: undefined | string

Category of delivery date. Indicates whether the delivery date is to be entered and displayed as a calendar day, week or month. Maximum length: 1.

nullable

Optional performancePeriodEndDate

performancePeriodEndDate: Moment

End Date for Period of Performance.

nullable

Optional performancePeriodStartDate

performancePeriodStartDate: Moment

Start Date for Period of Performance.

nullable

Optional purchaseOrderQuantityUnit

purchaseOrderQuantityUnit: undefined | string

Purchase Order Unit of Measure. Specifies the unit of measure in which the material is ordered. Maximum length: 3.

nullable

Optional purchaseRequisition

purchaseRequisition: undefined | string

Purchase Requisition Number. Alphanumeric key uniquely identifying the document. Maximum length: 10.

nullable

Optional purchaseRequisitionItem

purchaseRequisitionItem: undefined | string

Item number of purchase requisition. Specifies the number that uniquely identifies an item in . Maximum length: 5.

nullable

purchasingDocument

purchasingDocument: string

Purchasing Document Number. Alphanumeric key uniquely identifying the document. Maximum length: 10.

purchasingDocumentItem

purchasingDocumentItem: string

Item Number of Purchasing Document. Specifies the number that uniquely identifies an item in . Maximum length: 5.

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 schedLineStscDeliveryDate

schedLineStscDeliveryDate: Moment

Statistics-Relevant Delivery Date. Date for the calculation of the delivery time. Calculation of the delivery time is an element in the determination of a supplier's adherence to delivery dates (that is, the supplier's delivery timeliness, or on-time delivery performance) in MM Supplier Evaluation.If it becomes known that the supplier can only deliver ordered goods some days later than originally stipulated, for instance, you can change the delivery date accordingly for materials planning and control purposes. However, the statistics-relevant delivery date remains unchanged.As a result, the supplier's "on-time delivery performance" score worsens. At the same time, it is ensured that materials planning and control works on the basis of the right date.The system inserts the delivery date into this field in the following cases:You do not enter a statistical delivery date.You change the delivery date, have not entered a statistical delivery date, and the PO or scheduling agreement delivery schedule has not yet been transmitted to the supplier.

nullable

scheduleLine

scheduleLine: string

Delivery Schedule Line Counter. Alphanumeric key uniquely identifying the document. Maximum length: 4.

Optional scheduleLineCommittedQuantity

scheduleLineCommittedQuantity: BigNumber

Committed Quantity. Specifies the quantity that is available or that can be delivered on confirmed date using warehouse stock and/or receipts.

nullable

Optional scheduleLineDeliveryDate

scheduleLineDeliveryDate: Moment

Item delivery date. Date on which an item is to be delivered or the service provided.

nullable

Optional scheduleLineDeliveryTime

scheduleLineDeliveryTime: Time

Delivery Date Time-Spot. Point in time on a certain date at which delivery is to take place.

nullable

Optional scheduleLineOrderQuantity

scheduleLineOrderQuantity: BigNumber

Scheduled Quantity. Quantity to be delivered by the supplier in respect of this schedule line. This quantity is referred to by Goods Receiving and Invoice Verification for checking purposes.

nullable

toSubcontractingComponent

toSubcontractingComponent: PoSubcontractingComponent[]

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

Static ALL_FIELDS

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

All fields selector.

Static DELIV_DATE_CATEGORY

DELIV_DATE_CATEGORY: StringField<PurchaseOrderScheduleLine> = new StringField('DelivDateCategory', PurchaseOrderScheduleLine, 'Edm.String')

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

Static PERFORMANCE_PERIOD_END_DATE

PERFORMANCE_PERIOD_END_DATE: DateField<PurchaseOrderScheduleLine> = new DateField('PerformancePeriodEndDate', PurchaseOrderScheduleLine, 'Edm.DateTime')

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

Static PERFORMANCE_PERIOD_START_DATE

PERFORMANCE_PERIOD_START_DATE: DateField<PurchaseOrderScheduleLine> = new DateField('PerformancePeriodStartDate', PurchaseOrderScheduleLine, 'Edm.DateTime')

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

Static PURCHASE_ORDER_QUANTITY_UNIT

PURCHASE_ORDER_QUANTITY_UNIT: StringField<PurchaseOrderScheduleLine> = new StringField('PurchaseOrderQuantityUnit', PurchaseOrderScheduleLine, 'Edm.String')

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

Static PURCHASE_REQUISITION

PURCHASE_REQUISITION: StringField<PurchaseOrderScheduleLine> = new StringField('PurchaseRequisition', PurchaseOrderScheduleLine, 'Edm.String')

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

Static PURCHASE_REQUISITION_ITEM

PURCHASE_REQUISITION_ITEM: StringField<PurchaseOrderScheduleLine> = new StringField('PurchaseRequisitionItem', PurchaseOrderScheduleLine, 'Edm.String')

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

Static PURCHASING_DOCUMENT

PURCHASING_DOCUMENT: StringField<PurchaseOrderScheduleLine> = new StringField('PurchasingDocument', PurchaseOrderScheduleLine, 'Edm.String')

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

Static PURCHASING_DOCUMENT_ITEM

PURCHASING_DOCUMENT_ITEM: StringField<PurchaseOrderScheduleLine> = new StringField('PurchasingDocumentItem', PurchaseOrderScheduleLine, 'Edm.String')

Static representation of the purchasingDocumentItem 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<PurchaseOrderScheduleLine> = new StringField('ScheduleLine', PurchaseOrderScheduleLine, '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_COMMITTED_QUANTITY

SCHEDULE_LINE_COMMITTED_QUANTITY: BigNumberField<PurchaseOrderScheduleLine> = new BigNumberField('ScheduleLineCommittedQuantity', PurchaseOrderScheduleLine, 'Edm.Decimal')

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

Static SCHEDULE_LINE_DELIVERY_DATE

SCHEDULE_LINE_DELIVERY_DATE: DateField<PurchaseOrderScheduleLine> = new DateField('ScheduleLineDeliveryDate', PurchaseOrderScheduleLine, 'Edm.DateTime')

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

Static SCHEDULE_LINE_DELIVERY_TIME

SCHEDULE_LINE_DELIVERY_TIME: TimeField<PurchaseOrderScheduleLine> = new TimeField('ScheduleLineDeliveryTime', PurchaseOrderScheduleLine, 'Edm.Time')

Static representation of the scheduleLineDeliveryTime 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<PurchaseOrderScheduleLine> = new BigNumberField('ScheduleLineOrderQuantity', PurchaseOrderScheduleLine, '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 SCHED_LINE_STSC_DELIVERY_DATE

SCHED_LINE_STSC_DELIVERY_DATE: DateField<PurchaseOrderScheduleLine> = new DateField('SchedLineStscDeliveryDate', PurchaseOrderScheduleLine, 'Edm.DateTime')

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

Static TO_SUBCONTRACTING_COMPONENT

TO_SUBCONTRACTING_COMPONENT: Link<PurchaseOrderScheduleLine, PoSubcontractingComponent> = new Link('to_SubcontractingComponent', PurchaseOrderScheduleLine, PoSubcontractingComponent)

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

Static _allFields

_allFields: Array<StringField<PurchaseOrderScheduleLine> | DateField<PurchaseOrderScheduleLine> | BigNumberField<PurchaseOrderScheduleLine> | TimeField<PurchaseOrderScheduleLine> | Link<PurchaseOrderScheduleLine, PoSubcontractingComponent>> = [PurchaseOrderScheduleLine.PURCHASING_DOCUMENT,PurchaseOrderScheduleLine.PURCHASING_DOCUMENT_ITEM,PurchaseOrderScheduleLine.SCHEDULE_LINE,PurchaseOrderScheduleLine.DELIV_DATE_CATEGORY,PurchaseOrderScheduleLine.SCHEDULE_LINE_DELIVERY_DATE,PurchaseOrderScheduleLine.PURCHASE_ORDER_QUANTITY_UNIT,PurchaseOrderScheduleLine.SCHEDULE_LINE_ORDER_QUANTITY,PurchaseOrderScheduleLine.SCHEDULE_LINE_DELIVERY_TIME,PurchaseOrderScheduleLine.SCHED_LINE_STSC_DELIVERY_DATE,PurchaseOrderScheduleLine.PURCHASE_REQUISITION,PurchaseOrderScheduleLine.PURCHASE_REQUISITION_ITEM,PurchaseOrderScheduleLine.SCHEDULE_LINE_COMMITTED_QUANTITY,PurchaseOrderScheduleLine.PERFORMANCE_PERIOD_START_DATE,PurchaseOrderScheduleLine.PERFORMANCE_PERIOD_END_DATE,PurchaseOrderScheduleLine.TO_SUBCONTRACTING_COMPONENT]

All fields of the PurchaseOrderScheduleLine entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_PurchaseOrderScheduleLine"

Technical entity name for PurchaseOrderScheduleLine.

Static _keyFields

_keyFields: Array<Selectable<PurchaseOrderScheduleLine>> = [PurchaseOrderScheduleLine.PURCHASING_DOCUMENT, PurchaseOrderScheduleLine.PURCHASING_DOCUMENT_ITEM, PurchaseOrderScheduleLine.SCHEDULE_LINE]

All key fields of the PurchaseOrderScheduleLine entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PURCHASEORDER_PROCESS_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PurchaseOrderScheduleLine>

    A builder that constructs instances of entity type PurchaseOrderScheduleLine.

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

    Returns PurchaseOrderScheduleLineRequestBuilder

    A PurchaseOrderScheduleLine request builder.