Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_SalesSchedgAgrmtSchedLine" of service "API_SALES_SCHEDULING_AGREEMENT". This service is part of the following communication scenarios: Sales Scheduling Agreements Integration (SAP_COM_0360). See https://api.sap.com/api/API_SALES_SCHEDULING_AGREEMENT for more information.

Hierarchy

  • Entity
    • SalesSchedgAgrmtSchedLine

Implements

Index

Constructors

Properties

Methods

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 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 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: undefined | string

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

nullable

Optional goodsIssueDate

goodsIssueDate: Moment

Goods Issue Date. The date on which the goods must physically leave the shipping point to reach the customer on time. When the goods physically leave the shipping point, the system automatically creates a goods issue document to account for the outgoing inventory. The invoice that you subsequently send to the customer must correspond to the movement of inventory. The goods issue date enables the accounting department to relate the movement of goods to the invoice.The system automatically calculates the goods issue date by taking into account the following factors:The requested delivery dateThe pick/pack timeThe loading timeThe transit timeYou can change the date manually during delivery processing.

nullable

Optional goodsIssueTime

goodsIssueTime: Time

Time of Goods Issue (Local, Relating to a Plant).

nullable

Optional goodsMovementType

goodsMovementType: undefined | string

Goods Movement Type (Inventory Management). Specifies a key for the type of goods movement. Each goods movement (for example, purchase order to warehouse) is allocated to a movement type in the system. Maximum length: 3.

nullable

Optional loadingDate

loadingDate: Moment

Loading Date. The date by which picking and packing must be completed so that the goods are ready for loading and for the delivery to reach the customer on time. Any special packaging materials required for loading must also be available by this date. If items in the same delivery have different loading dates, the earliest date appears in the document header.The system uses predefined time estimates to calculate the loading date. The estimates take into account the following information:Shipping pointRouteLoading groupYou can change the loading date manually.

nullable

Optional loadingTime

loadingTime: Time

Loading Time (Local Time Relating to a Shipping Point).

nullable

Optional orderQuantityUnit

orderQuantityUnit: undefined | string

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

nullable

Optional productAvailabilityDate

productAvailabilityDate: Moment

Material Staging/Availability Date. The date by which sufficient quantities of the item must be available for picking to begin. The system uses the material availability date to generate automatic production and purchasing requirements. The system calculates the material availability date by working backwards from the customer's requested delivery date, taking into account how much time is needed for delivery-related procedures, such as picking, packing, loading, and transportation.The system proposes the material availability date. You can change the date manually in the sales document.The picking date is the same as the material availability date.

nullable

Optional productAvailabilityTime

productAvailabilityTime: Time

Material Staging Time (Local, Relating to a Plant).

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

Optional requestedDeliveryTime

requestedDeliveryTime: Time

Arrival time. The time at which the item should arrive at the customer site. The time is proposed for the scheduled day of delivery. You can store information about the customer's receiving hours in the customer master record of the ship-to party. This information includes receiving hours for each working day and for each of the customer's unloading points.If the system proposes an arrival time, you can change the proposal manually in the sales order. If the customer allows deliveries during a certain time slot, the system proposes the earliest time in the slot.If you schedule a delivery for a Monday and the customer has receiving hours between 8am and 12am, the system proposes 8am as the earliest possible arrival time.

nullable

Optional salesDelivDateCategory

salesDelivDateCategory: undefined | string

Date Type (day, week, month, interval). Maximum length: 1.

nullable

salesSchedulingAgreement

salesSchedulingAgreement: string

Sales Scheduling Agreement. The number that uniquely identifies the sales scheduling agreement. Maximum length: 10.

salesSchedulingAgreementItem

salesSchedulingAgreementItem: string

Sales Scheduling Agreement Item. The number that uniquely identifies the item in the sales scheduling agreement. 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 scheduleLineCategory

scheduleLineCategory: undefined | string

Schedule line category. A classification that distinguishes between different kinds of schedule line. The category determines how the system processes the schedule line. The schedule line category determines, for example, whether the system passes on requirements to materials requirements planning (MRP). Maximum length: 2.

nullable

Optional scheduleLineOpenQuantity

scheduleLineOpenQuantity: BigNumber

Open quantity to be delivered (in sales unit). The confirmed schedule line quantity that is still to be delivered. The system calculates the open delivery quantity by taking into account:The confirmed quantityThe quantity already deliveredWhether the item has meanwhile been cancelled or rejectedWhether the schedule line is still relevant for deliveryA schedule line contains an order quantity of 100 pieces. An availability check confirms that only 80 pieces are available. There was already a partial delivery of 50 pieces. The resulting open delivery quantity amounts to 30 pieces. If the item had been marked as rejected, the open delivery quantity would have been zero.

nullable

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

Optional schedulingAgreementReleaseType

schedulingAgreementReleaseType: undefined | string

Release type. Maximum length: 1.

nullable

toSalesSchedgAgrmt

toSalesSchedgAgrmt: SalesSchedgAgrmt

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

toSalesSchedgAgrmtDelivSched

toSalesSchedgAgrmtDelivSched: SalesSchedgAgrmtDelivSched

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

toSalesSchedgAgrmtItem

toSalesSchedgAgrmtItem: SalesSchedgAgrmtItem

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

Optional transportationPlanningDate

transportationPlanningDate: Moment

Transportation Planning Date. The date by which you must arrange transportation so that the delivery can reach the customer on time. The system can propose the transportation scheduling date from predefined time estimates. Estimates may be based on the route. If items in a delivery have different transportation scheduling dates, the system displays the earliest date in the document header. You can change the date manually.If, for example, you plan to use an external carrier for trucking, you must arrange for a truck to be available when the goods are ready for loading.

nullable

Optional transportationPlanningTime

transportationPlanningTime: Time

Transp. Planning Time (Local, Relating to a Shipping Point).

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

All fields selector.

Static CONFD_ORDER_QTY_BY_MATL_AVAIL_CHECK

CONFD_ORDER_QTY_BY_MATL_AVAIL_CHECK: BigNumberField<SalesSchedgAgrmtSchedLine> = new BigNumberField('ConfdOrderQtyByMatlAvailCheck', SalesSchedgAgrmtSchedLine, '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 CORRECTED_QTY_IN_ORDER_QTY_UNIT

CORRECTED_QTY_IN_ORDER_QTY_UNIT: BigNumberField<SalesSchedgAgrmtSchedLine> = new BigNumberField('CorrectedQtyInOrderQtyUnit', SalesSchedgAgrmtSchedLine, '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 DELIV_BLOCK_REASON_FOR_SCHED_LINE

DELIV_BLOCK_REASON_FOR_SCHED_LINE: StringField<SalesSchedgAgrmtSchedLine> = new StringField('DelivBlockReasonForSchedLine', SalesSchedgAgrmtSchedLine, '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 GOODS_ISSUE_DATE

GOODS_ISSUE_DATE: DateField<SalesSchedgAgrmtSchedLine> = new DateField('GoodsIssueDate', SalesSchedgAgrmtSchedLine, 'Edm.DateTime')

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

Static GOODS_ISSUE_TIME

GOODS_ISSUE_TIME: TimeField<SalesSchedgAgrmtSchedLine> = new TimeField('GoodsIssueTime', SalesSchedgAgrmtSchedLine, 'Edm.Time')

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

Static GOODS_MOVEMENT_TYPE

GOODS_MOVEMENT_TYPE: StringField<SalesSchedgAgrmtSchedLine> = new StringField('GoodsMovementType', SalesSchedgAgrmtSchedLine, 'Edm.String')

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

Static LOADING_DATE

LOADING_DATE: DateField<SalesSchedgAgrmtSchedLine> = new DateField('LoadingDate', SalesSchedgAgrmtSchedLine, 'Edm.DateTime')

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

Static LOADING_TIME

LOADING_TIME: TimeField<SalesSchedgAgrmtSchedLine> = new TimeField('LoadingTime', SalesSchedgAgrmtSchedLine, 'Edm.Time')

Static representation of the loadingTime 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<SalesSchedgAgrmtSchedLine> = new StringField('OrderQuantityUnit', SalesSchedgAgrmtSchedLine, '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 PRODUCT_AVAILABILITY_DATE

PRODUCT_AVAILABILITY_DATE: DateField<SalesSchedgAgrmtSchedLine> = new DateField('ProductAvailabilityDate', SalesSchedgAgrmtSchedLine, 'Edm.DateTime')

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

Static PRODUCT_AVAILABILITY_TIME

PRODUCT_AVAILABILITY_TIME: TimeField<SalesSchedgAgrmtSchedLine> = new TimeField('ProductAvailabilityTime', SalesSchedgAgrmtSchedLine, 'Edm.Time')

Static representation of the productAvailabilityTime 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<SalesSchedgAgrmtSchedLine> = new DateField('RequestedDeliveryDate', SalesSchedgAgrmtSchedLine, '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 REQUESTED_DELIVERY_TIME

REQUESTED_DELIVERY_TIME: TimeField<SalesSchedgAgrmtSchedLine> = new TimeField('RequestedDeliveryTime', SalesSchedgAgrmtSchedLine, 'Edm.Time')

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

Static SALES_DELIV_DATE_CATEGORY

SALES_DELIV_DATE_CATEGORY: StringField<SalesSchedgAgrmtSchedLine> = new StringField('SalesDelivDateCategory', SalesSchedgAgrmtSchedLine, 'Edm.String')

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

Static SALES_SCHEDULING_AGREEMENT

SALES_SCHEDULING_AGREEMENT: StringField<SalesSchedgAgrmtSchedLine> = new StringField('SalesSchedulingAgreement', SalesSchedgAgrmtSchedLine, 'Edm.String')

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

Static SALES_SCHEDULING_AGREEMENT_ITEM

SALES_SCHEDULING_AGREEMENT_ITEM: StringField<SalesSchedgAgrmtSchedLine> = new StringField('SalesSchedulingAgreementItem', SalesSchedgAgrmtSchedLine, 'Edm.String')

Static representation of the salesSchedulingAgreementItem 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<SalesSchedgAgrmtSchedLine> = new StringField('ScheduleLine', SalesSchedgAgrmtSchedLine, '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_CATEGORY

SCHEDULE_LINE_CATEGORY: StringField<SalesSchedgAgrmtSchedLine> = new StringField('ScheduleLineCategory', SalesSchedgAgrmtSchedLine, 'Edm.String')

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

Static SCHEDULE_LINE_OPEN_QUANTITY

SCHEDULE_LINE_OPEN_QUANTITY: BigNumberField<SalesSchedgAgrmtSchedLine> = new BigNumberField('ScheduleLineOpenQuantity', SalesSchedgAgrmtSchedLine, 'Edm.Decimal')

Static representation of the scheduleLineOpenQuantity 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<SalesSchedgAgrmtSchedLine> = new BigNumberField('ScheduleLineOrderQuantity', SalesSchedgAgrmtSchedLine, '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_RELEASE_TYPE

SCHEDULING_AGREEMENT_RELEASE_TYPE: StringField<SalesSchedgAgrmtSchedLine> = new StringField('SchedulingAgreementReleaseType', SalesSchedgAgrmtSchedLine, 'Edm.String')

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

Static TO_SALES_SCHEDG_AGRMT

TO_SALES_SCHEDG_AGRMT: OneToOneLink<SalesSchedgAgrmtSchedLine, SalesSchedgAgrmt> = new OneToOneLink('to_SalesSchedgAgrmt', SalesSchedgAgrmtSchedLine, SalesSchedgAgrmt)

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

Static TO_SALES_SCHEDG_AGRMT_DELIV_SCHED

TO_SALES_SCHEDG_AGRMT_DELIV_SCHED: OneToOneLink<SalesSchedgAgrmtSchedLine, SalesSchedgAgrmtDelivSched> = new OneToOneLink('to_SalesSchedgAgrmtDelivSched', SalesSchedgAgrmtSchedLine, SalesSchedgAgrmtDelivSched)

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

Static TO_SALES_SCHEDG_AGRMT_ITEM

TO_SALES_SCHEDG_AGRMT_ITEM: OneToOneLink<SalesSchedgAgrmtSchedLine, SalesSchedgAgrmtItem> = new OneToOneLink('to_SalesSchedgAgrmtItem', SalesSchedgAgrmtSchedLine, SalesSchedgAgrmtItem)

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

Static TRANSPORTATION_PLANNING_DATE

TRANSPORTATION_PLANNING_DATE: DateField<SalesSchedgAgrmtSchedLine> = new DateField('TransportationPlanningDate', SalesSchedgAgrmtSchedLine, 'Edm.DateTime')

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

Static TRANSPORTATION_PLANNING_TIME

TRANSPORTATION_PLANNING_TIME: TimeField<SalesSchedgAgrmtSchedLine> = new TimeField('TransportationPlanningTime', SalesSchedgAgrmtSchedLine, 'Edm.Time')

Static representation of the transportationPlanningTime 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<SalesSchedgAgrmtSchedLine> | DateField<SalesSchedgAgrmtSchedLine> | TimeField<SalesSchedgAgrmtSchedLine> | BigNumberField<SalesSchedgAgrmtSchedLine> | OneToOneLink<SalesSchedgAgrmtSchedLine, SalesSchedgAgrmtDelivSched> | OneToOneLink<SalesSchedgAgrmtSchedLine, SalesSchedgAgrmt> | OneToOneLink<SalesSchedgAgrmtSchedLine, SalesSchedgAgrmtItem>> = [SalesSchedgAgrmtSchedLine.SALES_SCHEDULING_AGREEMENT,SalesSchedgAgrmtSchedLine.SALES_SCHEDULING_AGREEMENT_ITEM,SalesSchedgAgrmtSchedLine.SCHEDULE_LINE,SalesSchedgAgrmtSchedLine.SCHEDULING_AGREEMENT_RELEASE_TYPE,SalesSchedgAgrmtSchedLine.SCHEDULE_LINE_CATEGORY,SalesSchedgAgrmtSchedLine.ORDER_QUANTITY_UNIT,SalesSchedgAgrmtSchedLine.SALES_DELIV_DATE_CATEGORY,SalesSchedgAgrmtSchedLine.REQUESTED_DELIVERY_DATE,SalesSchedgAgrmtSchedLine.REQUESTED_DELIVERY_TIME,SalesSchedgAgrmtSchedLine.SCHEDULE_LINE_ORDER_QUANTITY,SalesSchedgAgrmtSchedLine.CORRECTED_QTY_IN_ORDER_QTY_UNIT,SalesSchedgAgrmtSchedLine.SCHEDULE_LINE_OPEN_QUANTITY,SalesSchedgAgrmtSchedLine.CONFD_ORDER_QTY_BY_MATL_AVAIL_CHECK,SalesSchedgAgrmtSchedLine.PRODUCT_AVAILABILITY_DATE,SalesSchedgAgrmtSchedLine.PRODUCT_AVAILABILITY_TIME,SalesSchedgAgrmtSchedLine.DELIV_BLOCK_REASON_FOR_SCHED_LINE,SalesSchedgAgrmtSchedLine.TRANSPORTATION_PLANNING_DATE,SalesSchedgAgrmtSchedLine.TRANSPORTATION_PLANNING_TIME,SalesSchedgAgrmtSchedLine.GOODS_ISSUE_DATE,SalesSchedgAgrmtSchedLine.LOADING_DATE,SalesSchedgAgrmtSchedLine.GOODS_ISSUE_TIME,SalesSchedgAgrmtSchedLine.LOADING_TIME,SalesSchedgAgrmtSchedLine.GOODS_MOVEMENT_TYPE,SalesSchedgAgrmtSchedLine.TO_SALES_SCHEDG_AGRMT_DELIV_SCHED,SalesSchedgAgrmtSchedLine.TO_SALES_SCHEDG_AGRMT,SalesSchedgAgrmtSchedLine.TO_SALES_SCHEDG_AGRMT_ITEM]

All fields of the SalesSchedgAgrmtSchedLine entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_SalesSchedgAgrmtSchedLine"

Technical entity name for SalesSchedgAgrmtSchedLine.

Static _keyFields

_keyFields: Array<Selectable<SalesSchedgAgrmtSchedLine>> = [SalesSchedgAgrmtSchedLine.SALES_SCHEDULING_AGREEMENT, SalesSchedgAgrmtSchedLine.SALES_SCHEDULING_AGREEMENT_ITEM, SalesSchedgAgrmtSchedLine.SCHEDULE_LINE]

All key fields of the SalesSchedgAgrmtSchedLine entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_SALES_SCHEDULING_AGREEMENT"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SalesSchedgAgrmtSchedLine>

    A builder that constructs instances of entity type SalesSchedgAgrmtSchedLine.

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

    Returns SalesSchedgAgrmtSchedLineRequestBuilder

    A SalesSchedgAgrmtSchedLine request builder.