Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • Entity
    • WorkCenterPipeLineOperation

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 confirmedQuantity

confirmedQuantity: BigNumber

Confirmed Quantity.

nullable

Optional confirmedQuantityInBaseUnit

confirmedQuantityInBaseUnit: undefined | string

Production Unit of Measure. Maximum length: 3.

nullable

Optional erlstSchedldExecDurnInWorkdays

erlstSchedldExecDurnInWorkdays: undefined | number

Earliest Scheduled Execution Duration in Workdays.

nullable

manufacturingOrder

manufacturingOrder: string

Manufacturing Order ID. Maximum length: 12.

manufacturingOrderCategory

manufacturingOrderCategory: string

Manufacturing Order Category. Maximum length: 2.

manufacturingOrderOperation

manufacturingOrderOperation: string

Manufacturing Order Operation. Maximum length: 4.

Optional manufacturingOrderSequence

manufacturingOrderSequence: undefined | string

Manufacturing Order Sequence. Maximum length: 6.

nullable

Optional material

material: undefined | string

Material Number for Order. Number of the material that is to be produced with this order. Maximum length: 40.

nullable

Optional mfgOrderOperationText

mfgOrderOperationText: undefined | string

Manufacturing Order Operation Text. Maximum length: 40.

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 operationIsReleased

operationIsReleased: undefined | false | true

Boolean Variable (X = True, - = False, Space = Unknown).

nullable

Optional operationUnit

operationUnit: undefined | string

Operation Unit of Measure. Maximum length: 3.

nullable

Optional remainingDuration

remainingDuration: undefined | number

Remaining Duration.

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

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

workCenterInternalId

workCenterInternalId: string

Work Center Internal ID. Maximum length: 8.

Static ALL_FIELDS

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

All fields selector.

Static CONFIRMED_QUANTITY

CONFIRMED_QUANTITY: BigNumberField<WorkCenterPipeLineOperation> = new BigNumberField('ConfirmedQuantity', WorkCenterPipeLineOperation, 'Edm.Decimal')

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

Static CONFIRMED_QUANTITY_IN_BASE_UNIT

CONFIRMED_QUANTITY_IN_BASE_UNIT: StringField<WorkCenterPipeLineOperation> = new StringField('ConfirmedQuantityInBaseUnit', WorkCenterPipeLineOperation, 'Edm.String')

Static representation of the confirmedQuantityInBaseUnit 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<WorkCenterPipeLineOperation> = new NumberField('ErlstSchedldExecDurnInWorkdays', WorkCenterPipeLineOperation, '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 MANUFACTURING_ORDER

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

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

MFG_ORDER_OPERATION_TEXT: StringField<WorkCenterPipeLineOperation> = new StringField('MfgOrderOperationText', WorkCenterPipeLineOperation, '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 OPERATION_IS_RELEASED

OPERATION_IS_RELEASED: BooleanField<WorkCenterPipeLineOperation> = new BooleanField('OperationIsReleased', WorkCenterPipeLineOperation, 'Edm.Boolean')

Static representation of the operationIsReleased 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<WorkCenterPipeLineOperation> = new StringField('OperationUnit', WorkCenterPipeLineOperation, '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_ERLST_SCHEDLD_EXEC_END_DTE

OP_ERLST_SCHEDLD_EXEC_END_DTE: DateField<WorkCenterPipeLineOperation> = new DateField('OpErlstSchedldExecEndDte', WorkCenterPipeLineOperation, '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<WorkCenterPipeLineOperation> = new TimeField('OpErlstSchedldExecEndTme', WorkCenterPipeLineOperation, '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<WorkCenterPipeLineOperation> = new DateField('OpErlstSchedldExecStrtDte', WorkCenterPipeLineOperation, '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<WorkCenterPipeLineOperation> = new TimeField('OpErlstSchedldExecStrtTme', WorkCenterPipeLineOperation, '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<WorkCenterPipeLineOperation> = new BigNumberField('OpPlannedTotalQuantity', WorkCenterPipeLineOperation, '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 REMAINING_DURATION

REMAINING_DURATION: NumberField<WorkCenterPipeLineOperation> = new NumberField('RemainingDuration', WorkCenterPipeLineOperation, 'Edm.Int32')

Static representation of the remainingDuration 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<WorkCenterPipeLineOperation> = new StringField('WorkCenterInternalID', WorkCenterPipeLineOperation, '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 _allFields

_allFields: Array<StringField<WorkCenterPipeLineOperation> | BooleanField<WorkCenterPipeLineOperation> | DateField<WorkCenterPipeLineOperation> | TimeField<WorkCenterPipeLineOperation> | BigNumberField<WorkCenterPipeLineOperation> | NumberField<WorkCenterPipeLineOperation>> = [WorkCenterPipeLineOperation.WORK_CENTER_INTERNAL_ID,WorkCenterPipeLineOperation.MANUFACTURING_ORDER,WorkCenterPipeLineOperation.MANUFACTURING_ORDER_OPERATION,WorkCenterPipeLineOperation.MANUFACTURING_ORDER_CATEGORY,WorkCenterPipeLineOperation.MFG_ORDER_OPERATION_TEXT,WorkCenterPipeLineOperation.MATERIAL,WorkCenterPipeLineOperation.OPERATION_IS_RELEASED,WorkCenterPipeLineOperation.OP_ERLST_SCHEDLD_EXEC_STRT_DTE,WorkCenterPipeLineOperation.OP_ERLST_SCHEDLD_EXEC_STRT_TME,WorkCenterPipeLineOperation.OP_ERLST_SCHEDLD_EXEC_END_DTE,WorkCenterPipeLineOperation.OP_ERLST_SCHEDLD_EXEC_END_TME,WorkCenterPipeLineOperation.OP_PLANNED_TOTAL_QUANTITY,WorkCenterPipeLineOperation.OPERATION_UNIT,WorkCenterPipeLineOperation.CONFIRMED_QUANTITY,WorkCenterPipeLineOperation.CONFIRMED_QUANTITY_IN_BASE_UNIT,WorkCenterPipeLineOperation.ERLST_SCHEDLD_EXEC_DURN_IN_WORKDAYS,WorkCenterPipeLineOperation.REMAINING_DURATION,WorkCenterPipeLineOperation.MANUFACTURING_ORDER_SEQUENCE]

All fields of the WorkCenterPipeLineOperation entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_WorkCenterPipeLineOperation"

Technical entity name for WorkCenterPipeLineOperation.

Static _keyFields

_keyFields: Array<Selectable<WorkCenterPipeLineOperation>> = [WorkCenterPipeLineOperation.WORK_CENTER_INTERNAL_ID, WorkCenterPipeLineOperation.MANUFACTURING_ORDER, WorkCenterPipeLineOperation.MANUFACTURING_ORDER_OPERATION, WorkCenterPipeLineOperation.MANUFACTURING_ORDER_CATEGORY]

All key fields of the WorkCenterPipeLineOperation entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_WORK_CENTERS"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<WorkCenterPipeLineOperation>

    A builder that constructs instances of entity type WorkCenterPipeLineOperation.

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

    Returns WorkCenterPipeLineOperationRequestBuilder

    A WorkCenterPipeLineOperation request builder.