Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_PlannedOrderComponent" of service "API_PLANNED_ORDERS". This service is part of the following communication scenarios: Production Planning Integration (SAP_COM_0104). See https://api.sap.com/api/API_PLANNED_ORDERS for more information.

Hierarchy

  • Entity
    • PlannedOrderComponent

Implements

Index

Constructors

Properties

Accessors

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 assembly

assembly: undefined | string

Übergeordnetes Baugruppenmaterial. Gibt die Nummer der Baugruppe an, die den Bedarf der Komponente verursacht. Maximum length: 40.

nullable

Optional assemblyOrderLevelValue

assemblyOrderLevelValue: undefined | string

Auftragsstufe der Baugruppe. Maximum length: 2.

nullable

Optional assemblyOrderPathValue

assemblyOrderPathValue: undefined | string

Auftragsweg der Baugruppe. Maximum length: 2.

nullable

Optional baseUnit

baseUnit: undefined | string

Basismengeneinheit. Mengeneinheit, in der die Bestände des Materials geführt werden. In die Basismengeneinheit rechnet das System alle Mengen um, die Sie in anderen Mengeneinheiten (Alternativmengeneinheiten) erfassen. Die Basismengeneinheit sowie die Alternativmengeneinheiten mit den dazugehörigen Umrechnungsfaktoren legen Sie im Materialstammsatz fest.Da alle Datenfortschreibungen in der Basismengeneinheit erfolgen, ist die Eingabe, die Sie hier machen, im Hinblick auf die Umrechnung von Alternativmengeneinheiten besonders wichtig. In einer Alternativmengeinheit kann eine Menge nur dann exakt dargestellt werden, wenn die zur Verfügung stehenden Nachkommastellen zu ihrer Darstellung ausreichen. Damit dies gewährleistet ist, müssen Sie folgendes beachten:Die Basismengeneinheit ist die Einheit, die den höchsten notwendigen Genauigkeitsanspruch befriedigt.Umrechnungen der Alternativmengeneinheiten in die Basismengeneinheit sollten zu einfachen Dezimalbrüchen führen (also nicht 1/3 = 0,333...).BestandsführungIn der Bestandsführung ist die Basismengeneinheit gleichbedeutend mit der Lagermengeneinheit.DienstleistungFür Dienstleistungen gibt es eigene Mengeneinheiten, z.B.LeistungseinheitMengeneinheit auf der übergeordneten Ebene der Position. Die genauen Mengenangaben der einzelnen Leistungen stehen jeweils auf der detaillierten Ebene der Leistungszeile.pauschalMengeneinheit auf der Ebene der Leistungszeile für einmalig zu erbringende Leistungen, bei denen keine genauen Mengen angegeben werden können oder sollen. Maximum length: 3.

nullable

Optional billOfMaterialCategory

billOfMaterialCategory: undefined | string

Stücklistentypcode. Maximum length: 1.

nullable

Optional billOfMaterialInternalId

billOfMaterialInternalId: undefined | string

Stückliste. Nummer, die in Einheit mit dem Stücklistentyp eine Stückliste bzw. eine Stücklistengruppe eindeutig identifiziert. Die Nummernvergabe führt das System intern durch und ist für Sie irrelevant. Sie bearbeiten die entsprechende Stückliste über die Angabe des Objektes (z.B. Material, Equipment), zu dem die Stückliste gehört.Das System speichert unter dieser Nummeralle Alternativen einer Mehrfachstücklistealle Varianten einer VariantenstücklisteStücklisten, die mehreren Werken zugeordnet sind. Maximum length: 8.

nullable

Optional billOfMaterialItemNumber

billOfMaterialItemNumber: undefined | string

Nummer der Stücklistenposition. Positionsnummer der übernommenen Stücklistenkomponente. Maximum length: 4.

nullable

Optional billOfMaterialVariant

billOfMaterialVariant: undefined | string

Stücklistenalternative. Identifikation einer Stückliste innerhalb einer Stücklistengruppe. Ein und dasselbe Erzeugnis kann beispielsweise aufgrund unterschiedlicher Herstellungsverfahren für verschiedene Losgrößenbereiche durch mehrere Stücklisten (Alternativen) abgebildet werden. Diese alternativen Stücklisten werden in einer Mehrfachstückliste zusammengefaßt.Alternativen werden separat für unterschiedliche Stücklistenverwendungen gepflegt. Maximum length: 2.

nullable

Optional bomItem

bomItem: undefined | string

Stücklistenposition. Maximum length: 8.

nullable

Optional bomItemCategory

bomItemCategory: undefined | string

Stücklistenpositionstyp. Maximum length: 1.

nullable

Optional bomItemDescription

bomItemDescription: undefined | string

Stücklistenpositionstext (Zeile 1). Bis zu 40 Zeichen langer Text, der als erste von zwei Textzeilen die Position erläutert. Ist der Stücklistenpositionstext (zwei Zeilen von je 40 Zeichen) nicht ausreichend, so können Sie zusätzlich einen Positionslangtext erfassen, indem Sie im Menü Zusätze die Funktion Langtext -> Positionslangtext wählen.Beim Anlegen eines Positionslangtextes wird der Stücklistenpositionstext in die ersten 80 Zeichen des Langtextes übernommen.Eine Änderung des Stücklistenpositionstextes zieht bei existierendem Langtext automatisch eine Änderung der ersten 80 Zeichen des Langtextes nach sich und umgekehrt.Hinweis:Für Textpositionen wird dieser Text als Beschreibung der Komponente angezeigt. Maximum length: 40.

nullable

Optional componentScrapInPercent

componentScrapInPercent: BigNumber

Komponentenausschuss in Prozent. Angabe in Prozent, die während der Fertigung des Materials anfällt, wenn das Material eine Komponente ist. Der Komponentenausschuß wird in der Materialdisposition zur Ermittlung der Einsatzmengen der Komponenten verwendet. Bei der Stücklistenauflösung erhöht das System die Einsatzmengen der Komponenten um die berechnete Ausschußmenge.BeispielEinsatzmenge 200 StückKomponentenausschuß 10 %Ausschußmenge 20 Stück---> Eingesetzt werden 220 StückBeispiele für die Berechnung in Zusammenhang mit dem Kennzeichen für Netto-Ausschuß finden Sie unter Netto-Ausschuß.Wenn für eine übergeordnete Baugruppe ein Baugruppenausschuß gilt, addiert das System beide Ausschußarten.Ist in der Stückliste ein Komponentenausschuß eingetragen, gilt der dort angegebene Wert. Anderenfalls gilt der im Materialstammsatz angegebene Wert.

nullable

Optional debitCreditCode

debitCreditCode: undefined | string

Soll-/Haben-Code. Maximum length: 1.

nullable

Optional discontinuationGroup

discontinuationGroup: undefined | string

Auslaufgruppe. Maximum length: 2.

nullable

Optional entryUnit

entryUnit: undefined | string

Erfassungsmengeneinheit. Gibt die Mengeneinheit an, in der die Warenbewegung oder die Inventurzählung erfaßt wird. Geben Sie hier nur dann eine Mengeneinheit ein, wenn sie von der Vorschlagsmengeneinheit abweicht.Die Vorschlagsmengeneinheit ist:die Bestellmengeneinheit bei einem Wareneingang zur Bestellungdie Fertigungsmengeneinheit bei einem Wareneingang zum Auftragdie Ausgabemengeneinheit bei anderen Bewegungen.Wenn die Vorschlagsmengeneinheit im Materialstammsatz nicht definiert ist, schägt das System die Lagermengeneinheit vor. Maximum length: 3.

nullable

Optional followUpGroup

followUpGroup: undefined | string

Nachfolgegruppe. Maximum length: 2.

nullable

Optional followUpMaterial

followUpMaterial: undefined | string

Nachfolge-/Originalmaterial. Maximum length: 40.

nullable

Optional followUpMaterialIsNotActive

followUpMaterialIsNotActive: undefined | false | true

Kennzeichen: Nachfolgematerial ist aktiv.

nullable

Optional goodsMovementEntryQty

goodsMovementEntryQty: BigNumber

Menge in Erfassungsmengeneinheit.

nullable

Optional lastChangeDateTime

lastChangeDateTime: Moment

Letzte Aenderung Planauftrag: Zeitstempel.

nullable

Optional material

material: undefined | string

Materialnummer. Alphanumerischer Schlüssel, der das Material eindeutig identifiziert. Maximum length: 40.

nullable

Optional materialComponentIsPhantomItem

materialComponentIsPhantomItem: undefined | false | true

Dummy-Positionskennzeichen.

nullable

Optional matlCompDiscontinuationType

matlCompDiscontinuationType: undefined | string

Auslaufart. Kennzeichen, das das Material als Auslaufmaterial identifiziert und bei der Disposition die Auslaufsteuerung bewirkt. Das gesetzte Kennzeichen bewirkt, daß das System bei der Disposition den Sekundärbedarf, der nicht mehr durch den Lagerbestand des Materials gedeckt ist, auf das Nachfolgematerial weiterleitet.Voraussetzungen:Auslauf- und Nachfolgematerial müssen plangesteuert geplant werden.Die Basismengeneinheit des Nachfolgematerials muß mit der des Auslaufmaterials identisch sein. Maximum length: 1.

nullable

Optional matlCompIsFollowUpMaterial

matlCompIsFollowUpMaterial: undefined | false | true

Kennzeichen: Komponente ist Nachfolgematerial.

nullable

Optional matlCompRequirementDate

matlCompRequirementDate: Moment

Bedarfstermin für Materialkomponente.

nullable

Optional mrpController

mrpController: undefined | string

Disponent. Maximum length: 3.

nullable

Optional orderLevelValue

orderLevelValue: undefined | string

Auftragsstufe. Die Auftragsstufe bzw. der Auftragsweg sind ausschließlich für die Planung mit Dummybaugruppen relevant. Auftragsstufe und Auftragsweg geben zusammen die genaue Position einer Dummybaugruppe innerhalb einer Stückliste an.Eine Stückliste enthält folgende Dummybaugruppen (DummyBG) und Materialien:Material'A'___DummyBG'B' DummyBG'C' Material'D'_____ ___DummyBG'E' Material'F' Material'G' Material'H'Material'J'Um die Position einzelner Dummybaugruppen innerhalb der Stücklistenstruktur zurückzuverfolgen, werden die Auftragsstufen und Auftragswege nach der folgenden Logik vergeben:Pro Stücklistenstufe wird eine Nummer für die Auftragsstufe vergebenPro Stücklistenpfad wird eine Nummer für den Auftragsweg vergebenIn der folgenden Stückliste zeigt die erste Ziffer die Auftragsstufe, die zweite Ziffer den Auftragsweg. Dabei gilt: Ist ein Material keine Dummybaugruppe wird als Stufe bzw. Weg die Ziffer '0' vergeben. Ist ein Material jedoch Komponente einer Dummybaugruppe, dann vererbt die Dummybaugruppe ihre Stufe und Weg weiter an diese Komponente.Material'A'(0/0)___DummyBG'B' DummyBG'C' Material'D'(1/1) (1/2) (0/0)_____ ___DummyBG'E' Material'F' Material'G' Material'H'(2/1) (1/1) (1/2) (1/2)Material'J'(2/1). Maximum length: 2.

nullable

Optional orderPathValue

orderPathValue: undefined | string

Auftragsweg. Die Auftragsstufe bzw. der Auftragsweg sind ausschließlich für die Planung mit Dummybaugruppen relevant. Auftragsstufe und Auftragsweg geben zusammen die genaue Position einer Dummybaugruppe innerhalb einer Stückliste an.Eine Stückliste enthält folgende Dummybaugruppen (DummyBG) und Materialien:Material'A'___DummyBG'B' DummyBG'C' Material'D'_____ ___DummyBG'E' Material'F' Material'G' Material'H'Material'J'Um die Position einzelner Dummybaugruppen innerhalb der Stücklistenstruktur zurückzuverfolgen, werden die Auftragsstufen und Auftragswege nach der folgenden Logik vergeben:Pro Stücklistenstufe wird eine Nummer für die Auftragsstufe vergebenPro Stücklistenpfad wird eine Nummer für den Auftragsweg vergebenIn der folgenden Stückliste zeigt die erste Ziffer die Auftragsstufe, die zweite Ziffer den Auftragsweg. Dabei gilt: Ist ein Material keine Dummybaugruppe wird als Stufe bzw. Weg die Ziffer '0' vergeben. Ist ein Material jedoch Komponente einer Dummybaugruppe, dann vererbt die Dummybaugruppe ihre Stufe und Weg weiter an diese Komponente.Material'A'(0/0)___DummyBG'B' DummyBG'C' Material'D'(1/1) (1/2) (0/0)_____ ___DummyBG'E' Material'F' Material'G' Material'H'(2/1) (1/1) (1/2) (1/2)Material'J'(2/1). Maximum length: 2.

nullable

Optional plannedOrder

plannedOrder: undefined | string

Planauftrag. Identifiziert den Planauftrag zu einem Material eindeutig. Maximum length: 10.

nullable

Optional plant

plant: undefined | string

Werk. Schlüssel, der ein Werk eindeutig identifiziert. Maximum length: 4.

nullable

Optional quantityIsFixed

quantityIsFixed: undefined | false | true

Menge ist fix. Legt fest, daß die Menge einer Position konstant ist. Dieses Kennzeichen setzen Sie, wenn die Menge sich in einem Beziehungssystem nicht verändert.Wenn eine Position einer Stückliste als fix gekennzeichnet ist und die Menge des zu fertigenden Endprodukts geändert wird, so verändert sich die Menge dieser Position nicht.Wenn eine Beistellposition nicht als fix gekennzeichnet ist und die Menge der Lohnbearbeitung geändert wird, so verändert sich die Menge der Beistellposition proportional dazu.

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 requiredQuantity

requiredQuantity: BigNumber

Bedarfsmenge.

nullable

reservation

reservation: string

Nummer der Reservierung / des Sekundärbedarfs. Gibt einen alphanumerischen Schlüssel an, der den Beleg eindeutig identifiziert. Maximum length: 10.

reservationItem

reservationItem: string

Reservierungsposition. Maximum length: 4.

Optional sortField

sortField: undefined | string

Sortierbegriff. Frei definierbarer Begriff, nach dem Komponenten sortiert angezeigt werden können. Maximum length: 10.

nullable

Optional storageLocation

storageLocation: undefined | string

Lagerort. Maximum length: 4.

nullable

Optional supplyArea

supplyArea: undefined | string

Produktionsversorgungsbereich. Maximum length: 10.

nullable

Optional withdrawnQuantity

withdrawnQuantity: BigNumber

Entnommene Menge.

nullable

Static ALL_FIELDS

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

All fields selector.

Static ASSEMBLY

ASSEMBLY: StringField<PlannedOrderComponent> = new StringField('Assembly', PlannedOrderComponent, 'Edm.String')

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

Static ASSEMBLY_ORDER_LEVEL_VALUE

ASSEMBLY_ORDER_LEVEL_VALUE: StringField<PlannedOrderComponent> = new StringField('AssemblyOrderLevelValue', PlannedOrderComponent, 'Edm.String')

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

Static ASSEMBLY_ORDER_PATH_VALUE

ASSEMBLY_ORDER_PATH_VALUE: StringField<PlannedOrderComponent> = new StringField('AssemblyOrderPathValue', PlannedOrderComponent, 'Edm.String')

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

Static BASE_UNIT

BASE_UNIT: StringField<PlannedOrderComponent> = new StringField('BaseUnit', PlannedOrderComponent, 'Edm.String')

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

Static BILL_OF_MATERIAL_CATEGORY

BILL_OF_MATERIAL_CATEGORY: StringField<PlannedOrderComponent> = new StringField('BillOfMaterialCategory', PlannedOrderComponent, 'Edm.String')

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

Static BILL_OF_MATERIAL_INTERNAL_ID

BILL_OF_MATERIAL_INTERNAL_ID: StringField<PlannedOrderComponent> = new StringField('BillOfMaterialInternalID', PlannedOrderComponent, 'Edm.String')

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

Static BILL_OF_MATERIAL_ITEM_NUMBER

BILL_OF_MATERIAL_ITEM_NUMBER: StringField<PlannedOrderComponent> = new StringField('BillOfMaterialItemNumber', PlannedOrderComponent, 'Edm.String')

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

Static BILL_OF_MATERIAL_VARIANT

BILL_OF_MATERIAL_VARIANT: StringField<PlannedOrderComponent> = new StringField('BillOfMaterialVariant', PlannedOrderComponent, 'Edm.String')

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

Static BOM_ITEM

BOM_ITEM: StringField<PlannedOrderComponent> = new StringField('BOMItem', PlannedOrderComponent, 'Edm.String')

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

Static BOM_ITEM_CATEGORY

BOM_ITEM_CATEGORY: StringField<PlannedOrderComponent> = new StringField('BOMItemCategory', PlannedOrderComponent, 'Edm.String')

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

Static BOM_ITEM_DESCRIPTION

BOM_ITEM_DESCRIPTION: StringField<PlannedOrderComponent> = new StringField('BOMItemDescription', PlannedOrderComponent, 'Edm.String')

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

Static COMPONENT_SCRAP_IN_PERCENT

COMPONENT_SCRAP_IN_PERCENT: BigNumberField<PlannedOrderComponent> = new BigNumberField('ComponentScrapInPercent', PlannedOrderComponent, 'Edm.Decimal')

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

Static DEBIT_CREDIT_CODE

DEBIT_CREDIT_CODE: StringField<PlannedOrderComponent> = new StringField('DebitCreditCode', PlannedOrderComponent, 'Edm.String')

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

Static DISCONTINUATION_GROUP

DISCONTINUATION_GROUP: StringField<PlannedOrderComponent> = new StringField('DiscontinuationGroup', PlannedOrderComponent, 'Edm.String')

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

Static ENTRY_UNIT

ENTRY_UNIT: StringField<PlannedOrderComponent> = new StringField('EntryUnit', PlannedOrderComponent, 'Edm.String')

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

Static FOLLOW_UP_GROUP

FOLLOW_UP_GROUP: StringField<PlannedOrderComponent> = new StringField('FollowUpGroup', PlannedOrderComponent, 'Edm.String')

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

Static FOLLOW_UP_MATERIAL

FOLLOW_UP_MATERIAL: StringField<PlannedOrderComponent> = new StringField('FollowUpMaterial', PlannedOrderComponent, 'Edm.String')

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

Static FOLLOW_UP_MATERIAL_IS_NOT_ACTIVE

FOLLOW_UP_MATERIAL_IS_NOT_ACTIVE: BooleanField<PlannedOrderComponent> = new BooleanField('FollowUpMaterialIsNotActive', PlannedOrderComponent, 'Edm.Boolean')

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

Static GOODS_MOVEMENT_ENTRY_QTY

GOODS_MOVEMENT_ENTRY_QTY: BigNumberField<PlannedOrderComponent> = new BigNumberField('GoodsMovementEntryQty', PlannedOrderComponent, 'Edm.Decimal')

Static representation of the goodsMovementEntryQty 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<PlannedOrderComponent> = new DateField('LastChangeDateTime', PlannedOrderComponent, '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<PlannedOrderComponent> = new StringField('Material', PlannedOrderComponent, '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_COMPONENT_IS_PHANTOM_ITEM

MATERIAL_COMPONENT_IS_PHANTOM_ITEM: BooleanField<PlannedOrderComponent> = new BooleanField('MaterialComponentIsPhantomItem', PlannedOrderComponent, 'Edm.Boolean')

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

Static MATL_COMP_DISCONTINUATION_TYPE

MATL_COMP_DISCONTINUATION_TYPE: StringField<PlannedOrderComponent> = new StringField('MatlCompDiscontinuationType', PlannedOrderComponent, 'Edm.String')

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

Static MATL_COMP_IS_FOLLOW_UP_MATERIAL

MATL_COMP_IS_FOLLOW_UP_MATERIAL: BooleanField<PlannedOrderComponent> = new BooleanField('MatlCompIsFollowUpMaterial', PlannedOrderComponent, 'Edm.Boolean')

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

Static MATL_COMP_REQUIREMENT_DATE

MATL_COMP_REQUIREMENT_DATE: DateField<PlannedOrderComponent> = new DateField('MatlCompRequirementDate', PlannedOrderComponent, 'Edm.DateTime')

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

Static MRP_CONTROLLER

MRP_CONTROLLER: StringField<PlannedOrderComponent> = new StringField('MRPController', PlannedOrderComponent, 'Edm.String')

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

Static ORDER_LEVEL_VALUE

ORDER_LEVEL_VALUE: StringField<PlannedOrderComponent> = new StringField('OrderLevelValue', PlannedOrderComponent, 'Edm.String')

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

Static ORDER_PATH_VALUE

ORDER_PATH_VALUE: StringField<PlannedOrderComponent> = new StringField('OrderPathValue', PlannedOrderComponent, 'Edm.String')

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

Static PLANNED_ORDER

PLANNED_ORDER: StringField<PlannedOrderComponent> = new StringField('PlannedOrder', PlannedOrderComponent, 'Edm.String')

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

Static PLANT

PLANT: StringField<PlannedOrderComponent> = new StringField('Plant', PlannedOrderComponent, '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 QUANTITY_IS_FIXED

QUANTITY_IS_FIXED: BooleanField<PlannedOrderComponent> = new BooleanField('QuantityIsFixed', PlannedOrderComponent, 'Edm.Boolean')

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

Static REQUIRED_QUANTITY

REQUIRED_QUANTITY: BigNumberField<PlannedOrderComponent> = new BigNumberField('RequiredQuantity', PlannedOrderComponent, 'Edm.Decimal')

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

Static RESERVATION

RESERVATION: StringField<PlannedOrderComponent> = new StringField('Reservation', PlannedOrderComponent, 'Edm.String')

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

Static RESERVATION_ITEM

RESERVATION_ITEM: StringField<PlannedOrderComponent> = new StringField('ReservationItem', PlannedOrderComponent, 'Edm.String')

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

Static SORT_FIELD

SORT_FIELD: StringField<PlannedOrderComponent> = new StringField('SortField', PlannedOrderComponent, 'Edm.String')

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

Static STORAGE_LOCATION

STORAGE_LOCATION: StringField<PlannedOrderComponent> = new StringField('StorageLocation', PlannedOrderComponent, 'Edm.String')

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

Static SUPPLY_AREA

SUPPLY_AREA: StringField<PlannedOrderComponent> = new StringField('SupplyArea', PlannedOrderComponent, 'Edm.String')

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

Static WITHDRAWN_QUANTITY

WITHDRAWN_QUANTITY: BigNumberField<PlannedOrderComponent> = new BigNumberField('WithdrawnQuantity', PlannedOrderComponent, 'Edm.Decimal')

Static representation of the withdrawnQuantity 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<PlannedOrderComponent> | DateField<PlannedOrderComponent> | BigNumberField<PlannedOrderComponent> | BooleanField<PlannedOrderComponent>> = [PlannedOrderComponent.RESERVATION,PlannedOrderComponent.RESERVATION_ITEM,PlannedOrderComponent.PLANNED_ORDER,PlannedOrderComponent.BOM_ITEM,PlannedOrderComponent.BOM_ITEM_DESCRIPTION,PlannedOrderComponent.BILL_OF_MATERIAL_CATEGORY,PlannedOrderComponent.SORT_FIELD,PlannedOrderComponent.BILL_OF_MATERIAL_ITEM_NUMBER,PlannedOrderComponent.BILL_OF_MATERIAL_INTERNAL_ID,PlannedOrderComponent.BILL_OF_MATERIAL_VARIANT,PlannedOrderComponent.BOM_ITEM_CATEGORY,PlannedOrderComponent.MATERIAL,PlannedOrderComponent.MATL_COMP_REQUIREMENT_DATE,PlannedOrderComponent.GOODS_MOVEMENT_ENTRY_QTY,PlannedOrderComponent.ENTRY_UNIT,PlannedOrderComponent.REQUIRED_QUANTITY,PlannedOrderComponent.BASE_UNIT,PlannedOrderComponent.WITHDRAWN_QUANTITY,PlannedOrderComponent.DEBIT_CREDIT_CODE,PlannedOrderComponent.COMPONENT_SCRAP_IN_PERCENT,PlannedOrderComponent.QUANTITY_IS_FIXED,PlannedOrderComponent.MATERIAL_COMPONENT_IS_PHANTOM_ITEM,PlannedOrderComponent.PLANT,PlannedOrderComponent.STORAGE_LOCATION,PlannedOrderComponent.SUPPLY_AREA,PlannedOrderComponent.MRP_CONTROLLER,PlannedOrderComponent.ORDER_PATH_VALUE,PlannedOrderComponent.ORDER_LEVEL_VALUE,PlannedOrderComponent.ASSEMBLY,PlannedOrderComponent.ASSEMBLY_ORDER_PATH_VALUE,PlannedOrderComponent.ASSEMBLY_ORDER_LEVEL_VALUE,PlannedOrderComponent.DISCONTINUATION_GROUP,PlannedOrderComponent.MATL_COMP_DISCONTINUATION_TYPE,PlannedOrderComponent.MATL_COMP_IS_FOLLOW_UP_MATERIAL,PlannedOrderComponent.FOLLOW_UP_GROUP,PlannedOrderComponent.FOLLOW_UP_MATERIAL,PlannedOrderComponent.FOLLOW_UP_MATERIAL_IS_NOT_ACTIVE,PlannedOrderComponent.LAST_CHANGE_DATE_TIME]

All fields of the PlannedOrderComponent entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_PlannedOrderComponent"

Technical entity name for PlannedOrderComponent.

Static _keyFields

_keyFields: Array<Selectable<PlannedOrderComponent>> = [PlannedOrderComponent.RESERVATION, PlannedOrderComponent.RESERVATION_ITEM]

All key fields of the PlannedOrderComponent entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PLANNED_ORDERS"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PlannedOrderComponent>

    A builder that constructs instances of entity type PlannedOrderComponent.

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

    Returns PlannedOrderComponentRequestBuilder

    A PlannedOrderComponent request builder.