Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ProductionOrderOperation" of service "API_PRODUCTION_ORDERS". This service is part of the following communication scenarios: Production Planning Integration (SAP_COM_0104), Manufacturing Execution - Order and Confirmation Integration (SAP_COM_0522). See https://api.sap.com/api/API_PRODUCTION_ORDERS for more information.

Hierarchy

  • Entity
    • ProductionOrderOperation

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 businessProcessEntryUnit

businessProcessEntryUnit: undefined | string

Unit of Measure for Business Process Quantity. Unit in which work is confirmed. Maximum length: 3.

nullable

Optional erlstSchedldExecDurnInWorkdays

erlstSchedldExecDurnInWorkdays: undefined | number

Earliest Scheduled Execution Duration in Workdays.

nullable

Optional lastChangeDateTime

lastChangeDateTime: undefined | string

Last Change Date Time. Maximum length: 14.

nullable

Optional manufacturingOrder

manufacturingOrder: undefined | string

Manufacturing Order ID. Maximum length: 12.

nullable

Optional manufacturingOrderCategory

manufacturingOrderCategory: undefined | string

Manufacturing Order Category. Maximum length: 2.

nullable

Optional manufacturingOrderOperation

manufacturingOrderOperation: undefined | string

Manufacturing Order Operation. Maximum length: 4.

nullable

Optional manufacturingOrderSequence

manufacturingOrderSequence: undefined | string

Manufacturing Order Sequence. Maximum length: 6.

nullable

Optional manufacturingOrderType

manufacturingOrderType: undefined | string

Manufacturing Order Type. Maximum length: 4.

nullable

Optional mfgOrderOperationIsPhase

mfgOrderOperationIsPhase: undefined | false | true

Indicator: Phase. Indicator for phases as opposed to operations.

nullable

Optional mfgOrderOperationText

mfgOrderOperationText: undefined | string

Manufacturing Order Operation Text. Maximum length: 40.

nullable

Optional mfgOrderSequenceText

mfgOrderSequenceText: undefined | string

Manufacturing Order Sequence Text. Maximum length: 40.

nullable

Optional opActualExecutionDays

opActualExecutionDays: undefined | number

Actual Execution Duration in Workdays.

nullable

Optional opActualExecutionEndDate

opActualExecutionEndDate: Moment

Actual Execution End Date. Date on which the execution or the teardown of the operation or activity (PS) finished.

nullable

Optional opActualExecutionEndTime

opActualExecutionEndTime: Time

Actual Execution End Time. Time at which the execution or the teardown of the operation or activity (PS) finished.

nullable

Optional opActualExecutionStartDate

opActualExecutionStartDate: Moment

Actual Execution Start Date. Date on which the execution and/or the setup of the operation or activity (PS) started.

nullable

Optional opActualExecutionStartTime

opActualExecutionStartTime: Time

Actual Execution Start Time. Time at which the execution or the setup of the operation or activity (PS) started.

nullable

Optional opErlstSchedldExecEndDte

opErlstSchedldExecEndDte: Moment

Earliest Scheduled Execution End Date.

nullable

Optional opErlstSchedldExecEndTme

opErlstSchedldExecEndTme: Time

Earliest Scheduled Execution End Time.

nullable

Optional opErlstSchedldExecStrtDte

opErlstSchedldExecStrtDte: Moment

Earliest Scheduled Execution Start Date.

nullable

Optional opErlstSchedldExecStrtTme

opErlstSchedldExecStrtTme: Time

Earliest Scheduled Execution Start Time.

nullable

Optional opPlannedTotalQuantity

opPlannedTotalQuantity: BigNumber

Operation Total Quantity. Total quantity planned for this operation.

nullable

Optional opTotalConfirmedYieldQty

opTotalConfirmedYieldQty: BigNumber

Total Confirmed Yield. Yield confirmed for the operation.

nullable

Optional operationUnit

operationUnit: undefined | string

Operation Unit of Measure. Maximum length: 3.

nullable

orderIntBillOfOperationsItem

orderIntBillOfOperationsItem: string

Internal Identifier of an Operation or Activity. Maximum length: 8.

orderInternalBillOfOperations

orderInternalBillOfOperations: string

Order Internal ID. Maximum length: 10.

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 workCenter

workCenter: undefined | string

Work Center. Maximum length: 8.

nullable

Optional workCenterInternalId

workCenterInternalId: undefined | string

Work Center Internal ID. Maximum length: 8.

nullable

Optional workCenterTypeCode

workCenterTypeCode: undefined | string

Work Center Type Code. Maximum length: 1.

nullable

Static ALL_FIELDS

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

All fields selector.

Static BUSINESS_PROCESS_ENTRY_UNIT

BUSINESS_PROCESS_ENTRY_UNIT: StringField<ProductionOrderOperation> = new StringField('BusinessProcessEntryUnit', ProductionOrderOperation, 'Edm.String')

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

Static ERLST_SCHEDLD_EXEC_DURN_IN_WORKDAYS

ERLST_SCHEDLD_EXEC_DURN_IN_WORKDAYS: NumberField<ProductionOrderOperation> = new NumberField('ErlstSchedldExecDurnInWorkdays', ProductionOrderOperation, 'Edm.Int32')

Static representation of the erlstSchedldExecDurnInWorkdays 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: StringField<ProductionOrderOperation> = new StringField('LastChangeDateTime', ProductionOrderOperation, 'Edm.String')

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 MANUFACTURING_ORDER

MANUFACTURING_ORDER: StringField<ProductionOrderOperation> = new StringField('ManufacturingOrder', ProductionOrderOperation, '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<ProductionOrderOperation> = new StringField('ManufacturingOrderCategory', ProductionOrderOperation, '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<ProductionOrderOperation> = new StringField('ManufacturingOrderOperation', ProductionOrderOperation, '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<ProductionOrderOperation> = new StringField('ManufacturingOrderSequence', ProductionOrderOperation, '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<ProductionOrderOperation> = new StringField('ManufacturingOrderType', ProductionOrderOperation, '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 MFG_ORDER_OPERATION_IS_PHASE

MFG_ORDER_OPERATION_IS_PHASE: BooleanField<ProductionOrderOperation> = new BooleanField('MfgOrderOperationIsPhase', ProductionOrderOperation, 'Edm.Boolean')

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

Static MFG_ORDER_OPERATION_TEXT

MFG_ORDER_OPERATION_TEXT: StringField<ProductionOrderOperation> = new StringField('MfgOrderOperationText', ProductionOrderOperation, 'Edm.String')

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

Static MFG_ORDER_SEQUENCE_TEXT

MFG_ORDER_SEQUENCE_TEXT: StringField<ProductionOrderOperation> = new StringField('MfgOrderSequenceText', ProductionOrderOperation, 'Edm.String')

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

Static OPERATION_UNIT

OPERATION_UNIT: StringField<ProductionOrderOperation> = new StringField('OperationUnit', ProductionOrderOperation, 'Edm.String')

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

Static OP_ACTUAL_EXECUTION_DAYS

OP_ACTUAL_EXECUTION_DAYS: NumberField<ProductionOrderOperation> = new NumberField('OpActualExecutionDays', ProductionOrderOperation, 'Edm.Int32')

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

Static OP_ACTUAL_EXECUTION_END_DATE

OP_ACTUAL_EXECUTION_END_DATE: DateField<ProductionOrderOperation> = new DateField('OpActualExecutionEndDate', ProductionOrderOperation, 'Edm.DateTime')

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

Static OP_ACTUAL_EXECUTION_END_TIME

OP_ACTUAL_EXECUTION_END_TIME: TimeField<ProductionOrderOperation> = new TimeField('OpActualExecutionEndTime', ProductionOrderOperation, 'Edm.Time')

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

Static OP_ACTUAL_EXECUTION_START_DATE

OP_ACTUAL_EXECUTION_START_DATE: DateField<ProductionOrderOperation> = new DateField('OpActualExecutionStartDate', ProductionOrderOperation, 'Edm.DateTime')

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

Static OP_ACTUAL_EXECUTION_START_TIME

OP_ACTUAL_EXECUTION_START_TIME: TimeField<ProductionOrderOperation> = new TimeField('OpActualExecutionStartTime', ProductionOrderOperation, 'Edm.Time')

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

Static OP_ERLST_SCHEDLD_EXEC_END_DTE

OP_ERLST_SCHEDLD_EXEC_END_DTE: DateField<ProductionOrderOperation> = new DateField('OpErlstSchedldExecEndDte', ProductionOrderOperation, 'Edm.DateTime')

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

Static OP_ERLST_SCHEDLD_EXEC_END_TME

OP_ERLST_SCHEDLD_EXEC_END_TME: TimeField<ProductionOrderOperation> = new TimeField('OpErlstSchedldExecEndTme', ProductionOrderOperation, 'Edm.Time')

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

Static OP_ERLST_SCHEDLD_EXEC_STRT_DTE

OP_ERLST_SCHEDLD_EXEC_STRT_DTE: DateField<ProductionOrderOperation> = new DateField('OpErlstSchedldExecStrtDte', ProductionOrderOperation, 'Edm.DateTime')

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

Static OP_ERLST_SCHEDLD_EXEC_STRT_TME

OP_ERLST_SCHEDLD_EXEC_STRT_TME: TimeField<ProductionOrderOperation> = new TimeField('OpErlstSchedldExecStrtTme', ProductionOrderOperation, 'Edm.Time')

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

Static OP_PLANNED_TOTAL_QUANTITY

OP_PLANNED_TOTAL_QUANTITY: BigNumberField<ProductionOrderOperation> = new BigNumberField('OpPlannedTotalQuantity', ProductionOrderOperation, 'Edm.Decimal')

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

Static OP_TOTAL_CONFIRMED_YIELD_QTY

OP_TOTAL_CONFIRMED_YIELD_QTY: BigNumberField<ProductionOrderOperation> = new BigNumberField('OpTotalConfirmedYieldQty', ProductionOrderOperation, 'Edm.Decimal')

Static representation of the opTotalConfirmedYieldQty 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<ProductionOrderOperation> = new StringField('OrderInternalBillOfOperations', ProductionOrderOperation, '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 ORDER_INT_BILL_OF_OPERATIONS_ITEM

ORDER_INT_BILL_OF_OPERATIONS_ITEM: StringField<ProductionOrderOperation> = new StringField('OrderIntBillOfOperationsItem', ProductionOrderOperation, 'Edm.String')

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

Static WORK_CENTER

WORK_CENTER: StringField<ProductionOrderOperation> = new StringField('WorkCenter', ProductionOrderOperation, 'Edm.String')

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

Static WORK_CENTER_INTERNAL_ID

WORK_CENTER_INTERNAL_ID: StringField<ProductionOrderOperation> = new StringField('WorkCenterInternalID', ProductionOrderOperation, 'Edm.String')

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

Static WORK_CENTER_TYPE_CODE

WORK_CENTER_TYPE_CODE: StringField<ProductionOrderOperation> = new StringField('WorkCenterTypeCode', ProductionOrderOperation, 'Edm.String')

Static representation of the workCenterTypeCode 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<ProductionOrderOperation> | BooleanField<ProductionOrderOperation> | DateField<ProductionOrderOperation> | TimeField<ProductionOrderOperation> | BigNumberField<ProductionOrderOperation> | NumberField<ProductionOrderOperation>> = [ProductionOrderOperation.ORDER_INTERNAL_BILL_OF_OPERATIONS,ProductionOrderOperation.ORDER_INT_BILL_OF_OPERATIONS_ITEM,ProductionOrderOperation.MANUFACTURING_ORDER,ProductionOrderOperation.MANUFACTURING_ORDER_OPERATION,ProductionOrderOperation.MFG_ORDER_OPERATION_IS_PHASE,ProductionOrderOperation.MANUFACTURING_ORDER_SEQUENCE,ProductionOrderOperation.MFG_ORDER_SEQUENCE_TEXT,ProductionOrderOperation.MFG_ORDER_OPERATION_TEXT,ProductionOrderOperation.MANUFACTURING_ORDER_TYPE,ProductionOrderOperation.BUSINESS_PROCESS_ENTRY_UNIT,ProductionOrderOperation.MANUFACTURING_ORDER_CATEGORY,ProductionOrderOperation.WORK_CENTER_TYPE_CODE,ProductionOrderOperation.WORK_CENTER,ProductionOrderOperation.OP_ERLST_SCHEDLD_EXEC_STRT_DTE,ProductionOrderOperation.OP_ERLST_SCHEDLD_EXEC_STRT_TME,ProductionOrderOperation.OP_ERLST_SCHEDLD_EXEC_END_DTE,ProductionOrderOperation.OP_ERLST_SCHEDLD_EXEC_END_TME,ProductionOrderOperation.OP_ACTUAL_EXECUTION_START_DATE,ProductionOrderOperation.OP_ACTUAL_EXECUTION_START_TIME,ProductionOrderOperation.OP_ACTUAL_EXECUTION_END_DATE,ProductionOrderOperation.OP_ACTUAL_EXECUTION_END_TIME,ProductionOrderOperation.OPERATION_UNIT,ProductionOrderOperation.OP_PLANNED_TOTAL_QUANTITY,ProductionOrderOperation.ERLST_SCHEDLD_EXEC_DURN_IN_WORKDAYS,ProductionOrderOperation.OP_ACTUAL_EXECUTION_DAYS,ProductionOrderOperation.OP_TOTAL_CONFIRMED_YIELD_QTY,ProductionOrderOperation.WORK_CENTER_INTERNAL_ID,ProductionOrderOperation.LAST_CHANGE_DATE_TIME]

All fields of the ProductionOrderOperation entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ProductionOrderOperation"

Technical entity name for ProductionOrderOperation.

Static _keyFields

_keyFields: Array<Selectable<ProductionOrderOperation>> = [ProductionOrderOperation.ORDER_INTERNAL_BILL_OF_OPERATIONS, ProductionOrderOperation.ORDER_INT_BILL_OF_OPERATIONS_ITEM]

All key fields of the ProductionOrderOperation entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PRODUCTION_ORDERS"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProductionOrderOperation>

    A builder that constructs instances of entity type ProductionOrderOperation.

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

    Returns ProductionOrderOperationRequestBuilder

    A ProductionOrderOperation request builder.