Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • Entity
    • ProductionOrderComponent

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 baseUnit

baseUnit: string

Base Unit of Measure. Unit of measure in which stocks of the material are managed. The system converts all the quantities you enter in other units of measure (alternative units of measure) to the base unit of measure. You define the base unit of measure and also alternative units of measure and their conversion factors in the material master record.Since all data is updated in the base unit of measure, your entry is particularly important for the conversion of alternative units of measure. A quantity in the alternative unit of measure can only be shown precisely if its value can be shown with the decimal places available. To ensure this, please note the following:The base unit of measure is the unit satisfying the highest necessary requirement for precision.The conversion of alternative units of measure to the base unit should result in simple decimal fractions (not, for example, 1/3 = 0.333...).Inventory ManagementIn Inventory Management, the base unit of measure is the same as the stockkeeping unit.ServicesServices have units of measure of their own, including the following:Service unitUnit of measure at the higher item level. The precise quantities of the individual services are each at the detailed service line level.BlanketUnit of measure at service line level for services to be provided once only, and for which no precise quantities can or are to be specified. Maximum length: 3.

nullable

Optional billOfMaterialCategory

billOfMaterialCategory: string

Bill of Material Category Code. Maximum length: 1.

nullable

Optional billOfMaterialItemNumber

billOfMaterialItemNumber: string

BOM item number. Item number of the BOM components copied into the order. Maximum length: 4.

nullable

Optional bomItem

bomItem: string

Bill of Material Item. Maximum length: 8.

nullable

Optional bomItemCategory

bomItemCategory: string

Bill of Material Item Category. Maximum length: 1.

nullable

Optional bomItemDescription

bomItemDescription: string

BOM Item Text (Line 1). Text of up to 40 characters, which forms the first of two lines of text describing the item. If this text length (two lines of 40 characters each) is not sufficient, you can also enter a long text by choosing menu option Extras -> Long text -> Item.When you create an item long text, the first 80 characters of the BOM item text are copied to the long text.If you change the BOM item text, the first 80 characters of long text are automatically changed, too. If you change the first two lines of the BOM item long text, the short text is automatically changed.Note:For text items, this text is copied to the component description field on the item overview. Maximum length: 40.

nullable

Optional bomItemText2

bomItemText2: string

BOM Item Text (Line 2). Text of up to 40 characters, which forms the second of two lines of text describing the item. You can also enter a long text by choosing menu option Details --> Long text --> Item long text.If the text comprises less than three lines, it is stored in the BOM item. Otherwise, it is stored as a long text in the text database. Maximum length: 40.

nullable

Optional goodsRecipientName

goodsRecipientName: string

Goods Recipient. Maximum length: 12.

nullable

Optional manufacturingOrder

manufacturingOrder: string

Manufacturing Order ID. Maximum length: 12.

nullable

Optional manufacturingOrderCategory

manufacturingOrderCategory: string

Manufacturing Order Category. Maximum length: 2.

nullable

Optional manufacturingOrderOperation

manufacturingOrderOperation: string

Manufacturing Order Operation. Maximum length: 4.

nullable

Optional manufacturingOrderSequence

manufacturingOrderSequence: string

Sequence. Key which identifies a sequence of operations within a routing. Maximum length: 6.

nullable

Optional manufacturingOrderType

manufacturingOrderType: string

Manufacturing Order Type. Maximum length: 4.

nullable

Optional material

material: string

Material Number. Alphanumeric key uniquely identifying the material. Maximum length: 40.

nullable

Optional matlCompRequirementDate

matlCompRequirementDate: Moment

Material Component Requirement Date.

nullable

Optional orderInternalBillOfOperations

orderInternalBillOfOperations: string

Order Internal ID. Maximum length: 10.

nullable

Optional plant

plant: string

Plant. Key uniquely identifying a plant. Maximum length: 4.

nullable

Optional productionPlant

productionPlant: string

Production Plant in Planned Order. Plant in which the order quantity of the internally produced material is to be produced according to the planned order. Maximum length: 4.

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

Requirement Quantity. Specifies the quantity in the base unit of measure, which can have various meanings, depending on the situation: In the case of a planned order or a production order, this is the quantity of the material component required to manufacture the planned order quantity.In the case of a reservation, this is the quantity reserved.

nullable

reservation

reservation: string

Number of reservation/dependent requirements. Alphanumeric key uniquely identifying the document. Maximum length: 10.

reservationItem

reservationItem: string

Reservation Item. Maximum length: 4.

Optional sortField

sortField: string

Sort String. String which can be defined as required for sorting components for display. Maximum length: 10.

nullable

Optional storageLocation

storageLocation: string

Storage Location. Maximum length: 4.

nullable

Optional supplyArea

supplyArea: string

Production Supply Area. Maximum length: 10.

nullable

Optional unloadingPointName

unloadingPointName: string

Unloading Point. Specifies the point at which the material is to be unloaded (for example, ramp 1). Maximum length: 25.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

The ETag version identifier of the retrieved entity, returns undefined if not retrieved

Optional withdrawnQuantity

withdrawnQuantity: BigNumber

Withdrawn Quantity.

nullable

Static ALL_FIELDS

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

All fields selector.

Static BASE_UNIT

BASE_UNIT: StringField<ProductionOrderComponent> = new StringField('BaseUnit', ProductionOrderComponent, '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<ProductionOrderComponent> = new StringField('BillOfMaterialCategory', ProductionOrderComponent, '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_ITEM_NUMBER

BILL_OF_MATERIAL_ITEM_NUMBER: StringField<ProductionOrderComponent> = new StringField('BillOfMaterialItemNumber', ProductionOrderComponent, '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 BOM_ITEM

BOM_ITEM: StringField<ProductionOrderComponent> = new StringField('BOMItem', ProductionOrderComponent, '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<ProductionOrderComponent> = new StringField('BOMItemCategory', ProductionOrderComponent, '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<ProductionOrderComponent> = new StringField('BOMItemDescription', ProductionOrderComponent, '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 BOM_ITEM_TEXT_2

BOM_ITEM_TEXT_2: StringField<ProductionOrderComponent> = new StringField('BOMItemText2', ProductionOrderComponent, 'Edm.String')

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

Static GOODS_RECIPIENT_NAME

GOODS_RECIPIENT_NAME: StringField<ProductionOrderComponent> = new StringField('GoodsRecipientName', ProductionOrderComponent, 'Edm.String')

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

Static MANUFACTURING_ORDER

MANUFACTURING_ORDER: StringField<ProductionOrderComponent> = new StringField('ManufacturingOrder', ProductionOrderComponent, 'Edm.String')

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

Static MANUFACTURING_ORDER_CATEGORY

MANUFACTURING_ORDER_CATEGORY: StringField<ProductionOrderComponent> = new StringField('ManufacturingOrderCategory', ProductionOrderComponent, 'Edm.String')

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

Static MANUFACTURING_ORDER_OPERATION

MANUFACTURING_ORDER_OPERATION: StringField<ProductionOrderComponent> = new StringField('ManufacturingOrderOperation', ProductionOrderComponent, 'Edm.String')

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

Static MANUFACTURING_ORDER_SEQUENCE

MANUFACTURING_ORDER_SEQUENCE: StringField<ProductionOrderComponent> = new StringField('ManufacturingOrderSequence', ProductionOrderComponent, 'Edm.String')

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

Static MANUFACTURING_ORDER_TYPE

MANUFACTURING_ORDER_TYPE: StringField<ProductionOrderComponent> = new StringField('ManufacturingOrderType', ProductionOrderComponent, 'Edm.String')

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

Static MATERIAL

MATERIAL: StringField<ProductionOrderComponent> = new StringField('Material', ProductionOrderComponent, '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 MATL_COMP_REQUIREMENT_DATE

MATL_COMP_REQUIREMENT_DATE: DateField<ProductionOrderComponent> = new DateField('MatlCompRequirementDate', ProductionOrderComponent, '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 ORDER_INTERNAL_BILL_OF_OPERATIONS

ORDER_INTERNAL_BILL_OF_OPERATIONS: StringField<ProductionOrderComponent> = new StringField('OrderInternalBillOfOperations', ProductionOrderComponent, 'Edm.String')

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

Static PLANT

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

PRODUCTION_PLANT: StringField<ProductionOrderComponent> = new StringField('ProductionPlant', ProductionOrderComponent, 'Edm.String')

Static representation of the productionPlant 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<ProductionOrderComponent> = new BigNumberField('RequiredQuantity', ProductionOrderComponent, '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<ProductionOrderComponent> = new StringField('Reservation', ProductionOrderComponent, '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<ProductionOrderComponent> = new StringField('ReservationItem', ProductionOrderComponent, '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<ProductionOrderComponent> = new StringField('SortField', ProductionOrderComponent, '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<ProductionOrderComponent> = new StringField('StorageLocation', ProductionOrderComponent, '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<ProductionOrderComponent> = new StringField('SupplyArea', ProductionOrderComponent, '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 UNLOADING_POINT_NAME

UNLOADING_POINT_NAME: StringField<ProductionOrderComponent> = new StringField('UnloadingPointName', ProductionOrderComponent, 'Edm.String')

Static representation of the unloadingPointName 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<ProductionOrderComponent> = new BigNumberField('WithdrawnQuantity', ProductionOrderComponent, '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<ProductionOrderComponent> | DateField<ProductionOrderComponent> | BigNumberField<ProductionOrderComponent>> = [ProductionOrderComponent.RESERVATION,ProductionOrderComponent.RESERVATION_ITEM,ProductionOrderComponent.BILL_OF_MATERIAL_ITEM_NUMBER,ProductionOrderComponent.BOM_ITEM_DESCRIPTION,ProductionOrderComponent.MATERIAL,ProductionOrderComponent.PLANT,ProductionOrderComponent.PRODUCTION_PLANT,ProductionOrderComponent.MATL_COMP_REQUIREMENT_DATE,ProductionOrderComponent.BASE_UNIT,ProductionOrderComponent.REQUIRED_QUANTITY,ProductionOrderComponent.WITHDRAWN_QUANTITY,ProductionOrderComponent.BOM_ITEM,ProductionOrderComponent.STORAGE_LOCATION,ProductionOrderComponent.SUPPLY_AREA,ProductionOrderComponent.MANUFACTURING_ORDER_SEQUENCE,ProductionOrderComponent.MANUFACTURING_ORDER,ProductionOrderComponent.MANUFACTURING_ORDER_OPERATION,ProductionOrderComponent.MANUFACTURING_ORDER_CATEGORY,ProductionOrderComponent.MANUFACTURING_ORDER_TYPE,ProductionOrderComponent.ORDER_INTERNAL_BILL_OF_OPERATIONS,ProductionOrderComponent.BOM_ITEM_TEXT_2,ProductionOrderComponent.BOM_ITEM_CATEGORY,ProductionOrderComponent.BILL_OF_MATERIAL_CATEGORY,ProductionOrderComponent.SORT_FIELD,ProductionOrderComponent.GOODS_RECIPIENT_NAME,ProductionOrderComponent.UNLOADING_POINT_NAME]

All fields of the ProductionOrderComponent entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ProductionOrderComponent"

Technical entity name for ProductionOrderComponent.

Static _keyFields

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

All key fields of the ProductionOrderComponent entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PRODUCTION_ORDERS"
deprecated

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

Methods

Protected getCurrentMapKeys

  • getCurrentMapKeys(): Entity
  • Returns a map of all defined fields in entity to their current values.

    Returns Entity

    Entity with all defined entity fields

getCustomField

  • getCustomField(fieldName: string): any
  • Custom field value getter.

    Parameters

    • fieldName: string

      The name of the custom field

    Returns any

    The value of the corresponding custom field

getCustomFields

  • getCustomFields(): MapType<any>
  • Returns a map that contains all entity custom fields.

    Returns MapType<any>

    A map of all defined custom fields in the entity

getUpdatedCustomFields

  • getUpdatedCustomFields(): MapType<any>
  • Returns all updated custom field properties compared to the last known remote state.

    Returns MapType<any>

    A map containing all updated custom properties, with their new values

getUpdatedProperties

  • getUpdatedProperties(): Entity
  • Returns all changed properties compared to the last known remote state. The returned properties does not include custom fields. Use getUpdatedCustomFields, if updated custom fields are needed.

    Returns Entity

    Entity with all properties that changed

hasCustomField

  • hasCustomField(fieldName: string): boolean
  • Validates whether a custom field exists in the entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    Returns boolean

    A boolean value, that indicates whether a custom field is defined in entity

initializeCustomFields

  • initializeCustomFields(customFields: MapType<any>): this
  • Sets all retrieved custom fields in entity.

    Parameters

    • customFields: MapType<any>

      Extracted custom fields from a retrieved entity

    Returns this

    A boolean value, that indicates the existence of the field in entity

Protected isConflictingCustomField

  • isConflictingCustomField(customFieldName: string): boolean
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    Parameters

    • customFieldName: string

      Field name to check

    Returns boolean

    Boolean value that describes whether a field name can be defined as custom field

setCustomField

  • setCustomField(fieldName: string, value: any): this
  • Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    • value: any

      The value of the field

    Returns this

    The entity itself, to facilitate method chaining

setOrInitializeRemoteState

  • setOrInitializeRemoteState(state?: MapType<any>): this
  • Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests. This function should be called after initializeCustomFields, if custom fields are defined.

    Parameters

    • Optional state: MapType<any>

      State to be set as remote state

    Returns this

    The entity itself, to facilitate method chaining

setVersionIdentifier

  • setVersionIdentifier(etag: string): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string

      The returned ETag version of the entity

    Returns this

    The entity itself, to facilitate method chaining

toJSON

  • toJSON(): object
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    Returns object

    An object containing all instance variables + custom fields.

    • [key: string]: any

Static builder

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity ProductionOrderComponent.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProductionOrderComponent>

    A builder that constructs instances of entity type ProductionOrderComponent.

Static Protected customFieldSelector

  • customFieldSelector<EntityT>(fieldName: string, entityConstructor: Constructable<EntityT>): CustomField<EntityT>
  • Type parameters

    • EntityT: Entity

    Parameters

    • fieldName: string
    • entityConstructor: Constructable<EntityT>

    Returns CustomField<EntityT>

Static Protected entityBuilder

  • entityBuilder<EntityT, JsonT>(entityConstructor: Constructable<EntityT, JsonT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT, JsonT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the ProductionOrderComponent entity type.

    Returns ProductionOrderComponentRequestBuilder

    A ProductionOrderComponent request builder.