Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_SchAgrmtSchLine" of service "API_SCHED_AGRMT_PROCESS_SRV". This service is part of the following communication scenarios: Purchase Scheduling Agreement Integration (SAP_COM_0103). See https://api.sap.com/api/API_SCHED_AGRMT_PROCESS_SRV for more information.

Hierarchy

  • Entity
    • SchAgrmtSchLine

Implements

Index

Constructors

constructor

  • Returns SchAgrmtSchLine

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 noOfRemindersOfScheduleLine

noOfRemindersOfScheduleLine: BigNumber

No. of Reminders/Expediters for Schedule Line. Number of times a reminder or message urging delivery (expediter) has been sent with respect to a line of a delivery schedule created for an item of a purchase order or scheduling agreement. This field is filled by the reminder/expediting program (FI: dunning program). In the event of a change in the delivery date or the reminder (urging) levels, the counter for reminders and urging messages is deleted.In transactions for issuing reminders and expediters relating to purchasing documents, you can use this field as an additional selection criterion.In the list display for the reminder/expediting transactions, a counter for reminders and expediters is displayed. This counter is 1 higher than the selection criterion. This is because the list display shows the counter that would be assigned to the purchasing document if a new reminder or expediter were to be generated.To select only those purchasing documents in respect of which two reminders or expediters have already been issued, enter the value 2 as maximum reminder level.Only those purchasing documents will then be selected whose current counter is 2.On the list display of purchasing documents, the counter for reminders and expediters will show the value 3.

nullable

Optional prevDelivQtyOfScheduleLine

prevDelivQtyOfScheduleLine: BigNumber

Previous Quantity (Delivery Schedule Lines). Quantity notified to the supplier at the time of the last transmission.

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

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 roughGoodsReceiptQty

roughGoodsReceiptQty: BigNumber

Quantity of Goods Received. Specifies the quantity already delivered to date for this item or schedule line.

nullable

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 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 scheduleLineIsFixed

scheduleLineIsFixed: undefined | false | true

Schedule Line is "Fixed". Fixes the schedule line and determines that it cannot now be automatically changed as a result of materials planning and control/MRP activities. The indicator is set automatically if:You make manual changes to a line of a scheduling agreement delivery schedule that was created via the materials planning processYou create a schedule line manuallyYou can specify whether Materials Planning/MRP can change delivery schedule lines within the firm and trade-off zones in the additional data for the scheduling agreement item.

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

schedulingAgreement

schedulingAgreement: string

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

schedulingAgreementItem

schedulingAgreementItem: string

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

Optional sourceOfCreation

sourceOfCreation: undefined | string

Creation indicator (purchase requisition/schedule lines). Shows whether the purchase requisition or delivery schedule line was created manually or automatically (e.g. as a result of the requirements planning process). In the case of delivery schedules created under scheduling agreements, if schedule lines with different creation indicators are consolidated to form a release schedule line, the creation indicator remains "blank". Maximum length: 1.

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

All fields selector.

Static DELIV_DATE_CATEGORY

DELIV_DATE_CATEGORY: StringField<SchAgrmtSchLine> = new StringField('DelivDateCategory', SchAgrmtSchLine, '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 NO_OF_REMINDERS_OF_SCHEDULE_LINE

NO_OF_REMINDERS_OF_SCHEDULE_LINE: BigNumberField<SchAgrmtSchLine> = new BigNumberField('NoOfRemindersOfScheduleLine', SchAgrmtSchLine, 'Edm.Decimal')

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

Static PREV_DELIV_QTY_OF_SCHEDULE_LINE

PREV_DELIV_QTY_OF_SCHEDULE_LINE: BigNumberField<SchAgrmtSchLine> = new BigNumberField('PrevDelivQtyOfScheduleLine', SchAgrmtSchLine, 'Edm.Decimal')

Static representation of the prevDelivQtyOfScheduleLine 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<SchAgrmtSchLine> = new StringField('PurchaseRequisition', SchAgrmtSchLine, '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<SchAgrmtSchLine> = new StringField('PurchaseRequisitionItem', SchAgrmtSchLine, '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 ROUGH_GOODS_RECEIPT_QTY

ROUGH_GOODS_RECEIPT_QTY: BigNumberField<SchAgrmtSchLine> = new BigNumberField('RoughGoodsReceiptQty', SchAgrmtSchLine, 'Edm.Decimal')

Static representation of the roughGoodsReceiptQty 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<SchAgrmtSchLine> = new StringField('ScheduleLine', SchAgrmtSchLine, '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_DELIVERY_DATE

SCHEDULE_LINE_DELIVERY_DATE: DateField<SchAgrmtSchLine> = new DateField('ScheduleLineDeliveryDate', SchAgrmtSchLine, '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<SchAgrmtSchLine> = new TimeField('ScheduleLineDeliveryTime', SchAgrmtSchLine, '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_IS_FIXED

SCHEDULE_LINE_IS_FIXED: BooleanField<SchAgrmtSchLine> = new BooleanField('ScheduleLineIsFixed', SchAgrmtSchLine, 'Edm.Boolean')

Static representation of the scheduleLineIsFixed 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<SchAgrmtSchLine> = new BigNumberField('ScheduleLineOrderQuantity', SchAgrmtSchLine, '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 SCHEDULING_AGREEMENT

SCHEDULING_AGREEMENT: StringField<SchAgrmtSchLine> = new StringField('SchedulingAgreement', SchAgrmtSchLine, 'Edm.String')

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

Static SCHEDULING_AGREEMENT_ITEM

SCHEDULING_AGREEMENT_ITEM: StringField<SchAgrmtSchLine> = new StringField('SchedulingAgreementItem', SchAgrmtSchLine, 'Edm.String')

Static representation of the schedulingAgreementItem 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<SchAgrmtSchLine> = new DateField('SchedLineStscDeliveryDate', SchAgrmtSchLine, '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 SOURCE_OF_CREATION

SOURCE_OF_CREATION: StringField<SchAgrmtSchLine> = new StringField('SourceOfCreation', SchAgrmtSchLine, 'Edm.String')

Static representation of the sourceOfCreation 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<SchAgrmtSchLine> | DateField<SchAgrmtSchLine> | TimeField<SchAgrmtSchLine> | BigNumberField<SchAgrmtSchLine> | BooleanField<SchAgrmtSchLine>> = [SchAgrmtSchLine.SCHEDULING_AGREEMENT,SchAgrmtSchLine.SCHEDULING_AGREEMENT_ITEM,SchAgrmtSchLine.SCHEDULE_LINE,SchAgrmtSchLine.DELIV_DATE_CATEGORY,SchAgrmtSchLine.SCHEDULE_LINE_DELIVERY_DATE,SchAgrmtSchLine.SCHED_LINE_STSC_DELIVERY_DATE,SchAgrmtSchLine.SCHEDULE_LINE_DELIVERY_TIME,SchAgrmtSchLine.SCHEDULE_LINE_ORDER_QUANTITY,SchAgrmtSchLine.PURCHASE_REQUISITION,SchAgrmtSchLine.PURCHASE_REQUISITION_ITEM,SchAgrmtSchLine.ROUGH_GOODS_RECEIPT_QTY,SchAgrmtSchLine.SCHEDULE_LINE_IS_FIXED,SchAgrmtSchLine.NO_OF_REMINDERS_OF_SCHEDULE_LINE,SchAgrmtSchLine.PREV_DELIV_QTY_OF_SCHEDULE_LINE,SchAgrmtSchLine.SOURCE_OF_CREATION]

All fields of the SchAgrmtSchLine entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_SchAgrmtSchLine"

Technical entity name for SchAgrmtSchLine.

Static _keyFields

_keyFields: Array<Selectable<SchAgrmtSchLine>> = [SchAgrmtSchLine.SCHEDULING_AGREEMENT, SchAgrmtSchLine.SCHEDULING_AGREEMENT_ITEM, SchAgrmtSchLine.SCHEDULE_LINE]

All key fields of the SchAgrmtSchLine entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_SCHED_AGRMT_PROCESS_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SchAgrmtSchLine>

    A builder that constructs instances of entity type SchAgrmtSchLine.

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

    Returns SchAgrmtSchLineRequestBuilder

    A SchAgrmtSchLine request builder.