Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • Entity
    • ProcOrdConfirmation

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns ProcOrdConfirmation

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 confirmationScrapQuantity

confirmationScrapQuantity: BigNumber

Scrap to Be Confirmed. Scrap that you want to confirm for this operation.

nullable

Optional confirmationText

confirmationText: undefined | string

Confirmation Text. Maximum length: 40.

nullable

Optional confirmationUnit

confirmationUnit: undefined | string

Confirmation Unit of Measure. Unit in which the yield/scrap is confirmed. Maximum length: 3.

nullable

Optional confirmationYieldQuantity

confirmationYieldQuantity: BigNumber

Yield to be Confirmed. Yield that you want to confirm for the operation.

nullable

Optional enteredByExternalUser

enteredByExternalUser: undefined | string

Created By. Maximum length: 12.

nullable

Optional enteredByUser

enteredByUser: undefined | string

Entered By. Maximum length: 12.

nullable

Optional isFinalConfirmation

isFinalConfirmation: undefined | false | true

Activation of Final Confirmation. Specifies that no further confirmations are required. The system assigns the 'finally confirmed' system status.

nullable

Optional isReversed

isReversed: undefined | false | true

Indicator: Document was reversed.

nullable

Optional lastChangedByUser

lastChangedByUser: undefined | string

Changed By. The user who made the change. Maximum length: 12.

nullable

Optional manufacturingOrderCategory

manufacturingOrderCategory: undefined | string

Manufacturing Order Category. Maximum length: 2.

nullable

Optional manufacturingOrderOperation

manufacturingOrderOperation: undefined | string

Operation/Phase Number. Key uniquely identifying an operation or phase. Maximum length: 4.

nullable

Optional manufacturingOrderType

manufacturingOrderType: undefined | string

Manufacturing Order Type. Maximum length: 4.

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 materialName

materialName: undefined | string

Material Description. Text containing up to 40 characters that describes the material in more detail. You can enter one material description in each of any number of languages.In principle, you enter the material description on the data screen of the first user department for which you enter data, and in your logon language. You can overwrite the material description on the Basic Data screen. Maximum length: 40.

nullable

Optional mfgOrderConfirmationEntryDate

mfgOrderConfirmationEntryDate: Moment

Entry Date of Confirmation.

nullable

Optional mfgOrderConfirmationEntryTime

mfgOrderConfirmationEntryTime: Time

Confirmation Entry Time.

nullable

Optional mfgOrderOperationIsPhase

mfgOrderOperationIsPhase: undefined | false | true

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

nullable

Optional mfgOrderPlannedTotalQty

mfgOrderPlannedTotalQty: BigNumber

Manufacturing Order Planned Total Quantity.

nullable

Optional opTotalConfirmedScrapQty

opTotalConfirmedScrapQty: BigNumber

Total Scrap Quantity Confirmed. Scrap previously confirmed for the operation.

nullable

Optional opTotalConfirmedYieldQty

opTotalConfirmedYieldQty: BigNumber

Total Confirmed Yield. Yield confirmed for the operation.

nullable

operationConfirmationCount

operationConfirmationCount: string

Identifier of Single Order Confirmation. Maximum length: 8.

Optional postingDate

postingDate: Moment

Posting Date.

nullable

Optional processOrder

processOrder: undefined | string

Manufacturing Order ID. Maximum length: 12.

nullable

processOrderConfirmation

processOrderConfirmation: string

Collective ID of Order Confirmations. Maximum length: 10.

Optional productionPlant

productionPlant: undefined | string

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

nullable

Optional productionUnit

productionUnit: undefined | string

Production Unit of Measure. Maximum length: 3.

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

Optional workCenter

workCenter: undefined | string

Work Center. Indicates the work center or the resource that is used to generate a print request. Maximum length: 8.

nullable

Optional workCenterInternalId

workCenterInternalId: undefined | string

Work Center Internal ID. Maximum length: 8.

nullable

Optional workCenterTypeCode

workCenterTypeCode: undefined | string

Object types of the CIM resource. Internally used key which identifies the type of operating resource. For example, the following indicators represent: A - a work centerFH - a production resource/tool.The key is only used internally but it is displayed within matchcode selection on technical grounds. You do not have to make an entry. Maximum length: 2.

nullable

Static ALL_FIELDS

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

All fields selector.

Static CONFIRMATION_SCRAP_QUANTITY

CONFIRMATION_SCRAP_QUANTITY: BigNumberField<ProcOrdConfirmation> = new BigNumberField('ConfirmationScrapQuantity', ProcOrdConfirmation, 'Edm.Decimal')

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

Static CONFIRMATION_TEXT

CONFIRMATION_TEXT: StringField<ProcOrdConfirmation> = new StringField('ConfirmationText', ProcOrdConfirmation, 'Edm.String')

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

Static CONFIRMATION_UNIT

CONFIRMATION_UNIT: StringField<ProcOrdConfirmation> = new StringField('ConfirmationUnit', ProcOrdConfirmation, 'Edm.String')

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

Static CONFIRMATION_YIELD_QUANTITY

CONFIRMATION_YIELD_QUANTITY: BigNumberField<ProcOrdConfirmation> = new BigNumberField('ConfirmationYieldQuantity', ProcOrdConfirmation, 'Edm.Decimal')

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

Static ENTERED_BY_EXTERNAL_USER

ENTERED_BY_EXTERNAL_USER: StringField<ProcOrdConfirmation> = new StringField('EnteredByExternalUser', ProcOrdConfirmation, 'Edm.String')

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

Static ENTERED_BY_USER

ENTERED_BY_USER: StringField<ProcOrdConfirmation> = new StringField('EnteredByUser', ProcOrdConfirmation, 'Edm.String')

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

Static IS_FINAL_CONFIRMATION

IS_FINAL_CONFIRMATION: BooleanField<ProcOrdConfirmation> = new BooleanField('IsFinalConfirmation', ProcOrdConfirmation, 'Edm.Boolean')

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

Static IS_REVERSED

IS_REVERSED: BooleanField<ProcOrdConfirmation> = new BooleanField('IsReversed', ProcOrdConfirmation, 'Edm.Boolean')

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

Static LAST_CHANGED_BY_USER

LAST_CHANGED_BY_USER: StringField<ProcOrdConfirmation> = new StringField('LastChangedByUser', ProcOrdConfirmation, 'Edm.String')

Static representation of the lastChangedByUser 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<ProcOrdConfirmation> = new StringField('ManufacturingOrderCategory', ProcOrdConfirmation, '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<ProcOrdConfirmation> = new StringField('ManufacturingOrderOperation', ProcOrdConfirmation, '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_TYPE

MANUFACTURING_ORDER_TYPE: StringField<ProcOrdConfirmation> = new StringField('ManufacturingOrderType', ProcOrdConfirmation, '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<ProcOrdConfirmation> = new StringField('Material', ProcOrdConfirmation, '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_NAME

MATERIAL_NAME: StringField<ProcOrdConfirmation> = new StringField('MaterialName', ProcOrdConfirmation, 'Edm.String')

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

Static MFG_ORDER_CONFIRMATION_ENTRY_DATE

MFG_ORDER_CONFIRMATION_ENTRY_DATE: DateField<ProcOrdConfirmation> = new DateField('MfgOrderConfirmationEntryDate', ProcOrdConfirmation, 'Edm.DateTime')

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

Static MFG_ORDER_CONFIRMATION_ENTRY_TIME

MFG_ORDER_CONFIRMATION_ENTRY_TIME: TimeField<ProcOrdConfirmation> = new TimeField('MfgOrderConfirmationEntryTime', ProcOrdConfirmation, 'Edm.Time')

Static representation of the mfgOrderConfirmationEntryTime 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<ProcOrdConfirmation> = new BooleanField('MfgOrderOperationIsPhase', ProcOrdConfirmation, '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_PLANNED_TOTAL_QTY

MFG_ORDER_PLANNED_TOTAL_QTY: BigNumberField<ProcOrdConfirmation> = new BigNumberField('MfgOrderPlannedTotalQty', ProcOrdConfirmation, 'Edm.Decimal')

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

Static OPERATION_CONFIRMATION_COUNT

OPERATION_CONFIRMATION_COUNT: StringField<ProcOrdConfirmation> = new StringField('OperationConfirmationCount', ProcOrdConfirmation, 'Edm.String')

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

Static OP_TOTAL_CONFIRMED_SCRAP_QTY

OP_TOTAL_CONFIRMED_SCRAP_QTY: BigNumberField<ProcOrdConfirmation> = new BigNumberField('OpTotalConfirmedScrapQty', ProcOrdConfirmation, 'Edm.Decimal')

Static representation of the opTotalConfirmedScrapQty 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<ProcOrdConfirmation> = new BigNumberField('OpTotalConfirmedYieldQty', ProcOrdConfirmation, '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 POSTING_DATE

POSTING_DATE: DateField<ProcOrdConfirmation> = new DateField('PostingDate', ProcOrdConfirmation, 'Edm.DateTime')

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

Static PROCESS_ORDER

PROCESS_ORDER: StringField<ProcOrdConfirmation> = new StringField('ProcessOrder', ProcOrdConfirmation, 'Edm.String')

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

Static PROCESS_ORDER_CONFIRMATION

PROCESS_ORDER_CONFIRMATION: StringField<ProcOrdConfirmation> = new StringField('ProcessOrderConfirmation', ProcOrdConfirmation, 'Edm.String')

Static representation of the processOrderConfirmation 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<ProcOrdConfirmation> = new StringField('ProductionPlant', ProcOrdConfirmation, '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 PRODUCTION_UNIT

PRODUCTION_UNIT: StringField<ProcOrdConfirmation> = new StringField('ProductionUnit', ProcOrdConfirmation, 'Edm.String')

Static representation of the productionUnit 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<ProcOrdConfirmation> = new StringField('WorkCenter', ProcOrdConfirmation, '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<ProcOrdConfirmation> = new StringField('WorkCenterInternalID', ProcOrdConfirmation, '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<ProcOrdConfirmation> = new StringField('WorkCenterTypeCode', ProcOrdConfirmation, '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<ProcOrdConfirmation> | BigNumberField<ProcOrdConfirmation> | BooleanField<ProcOrdConfirmation> | DateField<ProcOrdConfirmation> | TimeField<ProcOrdConfirmation>> = [ProcOrdConfirmation.PROCESS_ORDER_CONFIRMATION,ProcOrdConfirmation.OPERATION_CONFIRMATION_COUNT,ProcOrdConfirmation.PROCESS_ORDER,ProcOrdConfirmation.MANUFACTURING_ORDER_TYPE,ProcOrdConfirmation.MANUFACTURING_ORDER_CATEGORY,ProcOrdConfirmation.MATERIAL,ProcOrdConfirmation.MATERIAL_NAME,ProcOrdConfirmation.PRODUCTION_UNIT,ProcOrdConfirmation.MFG_ORDER_PLANNED_TOTAL_QTY,ProcOrdConfirmation.MFG_ORDER_OPERATION_IS_PHASE,ProcOrdConfirmation.WORK_CENTER,ProcOrdConfirmation.MANUFACTURING_ORDER_OPERATION,ProcOrdConfirmation.WORK_CENTER_INTERNAL_ID,ProcOrdConfirmation.WORK_CENTER_TYPE_CODE,ProcOrdConfirmation.PRODUCTION_PLANT,ProcOrdConfirmation.IS_FINAL_CONFIRMATION,ProcOrdConfirmation.MFG_ORDER_CONFIRMATION_ENTRY_DATE,ProcOrdConfirmation.MFG_ORDER_CONFIRMATION_ENTRY_TIME,ProcOrdConfirmation.POSTING_DATE,ProcOrdConfirmation.IS_REVERSED,ProcOrdConfirmation.ENTERED_BY_EXTERNAL_USER,ProcOrdConfirmation.LAST_CHANGED_BY_USER,ProcOrdConfirmation.ENTERED_BY_USER,ProcOrdConfirmation.CONFIRMATION_UNIT,ProcOrdConfirmation.CONFIRMATION_YIELD_QUANTITY,ProcOrdConfirmation.OP_TOTAL_CONFIRMED_YIELD_QTY,ProcOrdConfirmation.CONFIRMATION_SCRAP_QUANTITY,ProcOrdConfirmation.OP_TOTAL_CONFIRMED_SCRAP_QTY,ProcOrdConfirmation.CONFIRMATION_TEXT]

All fields of the ProcOrdConfirmation entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ProcOrdConfirmation"

Technical entity name for ProcOrdConfirmation.

Static _keyFields

_keyFields: Array<Selectable<ProcOrdConfirmation>> = [ProcOrdConfirmation.PROCESS_ORDER_CONFIRMATION, ProcOrdConfirmation.OPERATION_CONFIRMATION_COUNT]

All key fields of the ProcOrdConfirmation entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PROC_ORDER_CONFIRMATION"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProcOrdConfirmation>

    A builder that constructs instances of entity type ProcOrdConfirmation.

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

    Returns ProcOrdConfirmationRequestBuilder

    A ProcOrdConfirmation request builder.