Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_InspectionOperation" of service "API_INSPECTIONLOT_SRV". This service is part of the following communication scenarios: Quality Inspection Process Integration (SAP_COM_0318). See https://api.sap.com/api/API_INSPECTIONLOT_SRV for more information.

Hierarchy

  • Entity
    • InspectionOperation

Implements

Index

Constructors

constructor

  • Returns InspectionOperation

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 billOfOperationsType

billOfOperationsType: string

Task List Type. Key which classifies task lists according to their functionality. Routings are defined under the following task list types:RoutingsReference operation setsMaster recipeGeneral maintenance task listEquipment task listInspection planTask list for funct. location. Maximum length: 1.

nullable

Optional booOperationInternalId

booOperationInternalId: string

Number of the Task List Node. Maximum length: 8.

nullable

inspPlanOperationInternalId

inspPlanOperationInternalId: string

Current Node Number from Order Counter. Maximum length: 8.

inspectionLot

inspectionLot: string

Inspection Lot Number. Number that uniquely identifies an inspection lot. The inspection lot number is assigned by the system. Maximum length: 12.

Optional inspectionOperation

inspectionOperation: string

Operation/Activity Number. Production Planning Determines in which order the operations of a sequence are carried out.Project SystemNumber that identifies an activity. Maximum length: 4.

nullable

Optional inspectionOperationPlant

inspectionOperationPlant: string

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

nullable

Optional inspectionSubSystem

inspectionSubSystem: string

Subsystem Identifier for QM Subsystem Interface. Logical description of an external system (non-SAP system, subsystem, QDE system) with which quality data from a quality inspection can be exchanged. Remember the following dependencies:Work center The integration of a subsystem into the QM module takes place by assigning the subsystem to a work center.Operation If you want an inspection operation to be processed in a subsystem, assign the operation to a work center for which a QDE system is maintained.QM-IDI interface For both the download of inspection specifications as well as the upload of inspection results via the QM-IDI interface, a subsystem is required. Maximum length: 6.

nullable

Optional operationConfirmation

operationConfirmation: string

Completion confirmation number for the operation. Number used to identify an operation in the confirmation. Maximum length: 10.

nullable

Optional operationControlProfile

operationControlProfile: string

Control Key. Determines which business transactions should be executed for the object that belongs to the task list or order (for example scheduling or costing). Which application component uses the controlkey for which objects is shown in the table below.QM PM PP PP-PI PSOperation/Activity x x x x xSub-Operation x x xPhase xSecondary Resource xActivity Element x. Maximum length: 4.

nullable

Optional operationText

operationText: string

Operation Short Text. Describes the operation or sub-operation. This text is copied into the first line of the long text for the operation or sub-operation.Character formats such as bold or italics are not supported in short texts. If you use special character formats in long texts, the system displays the corresponding control characters in the short text. Maximum length: 40.

nullable

Optional orderInternalBillOfOperations

orderInternalBillOfOperations: string

Routing number of operations in the order. Number of the routing or reference operation set used in the order. Maximum length: 10.

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 statusObject

statusObject: string

Object Number. An object (order, project, cost center, ...) is identified uniquely by its object number within a client. The object number is used in tables, which cover all objects, for instance in status administration, cost collection. Maximum length: 22.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Optional workCenterInternalId

workCenterInternalId: string

Object ID of the resource. This internally used number and the object type identify the operating resource (for example, the work center or production resource/tool). The number is only used internally but the system displays it within matchcode selection for technical reasons. You do not have to make an entry. Maximum length: 8.

nullable

Static ALL_FIELDS

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

All fields selector.

Static BILL_OF_OPERATIONS_TYPE

BILL_OF_OPERATIONS_TYPE: StringField<InspectionOperation> = new StringField('BillOfOperationsType', InspectionOperation, 'Edm.String')

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

Static BOO_OPERATION_INTERNAL_ID

BOO_OPERATION_INTERNAL_ID: StringField<InspectionOperation> = new StringField('BOOOperationInternalID', InspectionOperation, 'Edm.String')

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

Static INSPECTION_LOT

INSPECTION_LOT: StringField<InspectionOperation> = new StringField('InspectionLot', InspectionOperation, 'Edm.String')

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

Static INSPECTION_OPERATION

INSPECTION_OPERATION: StringField<InspectionOperation> = new StringField('InspectionOperation', InspectionOperation, 'Edm.String')

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

Static INSPECTION_OPERATION_PLANT

INSPECTION_OPERATION_PLANT: StringField<InspectionOperation> = new StringField('InspectionOperationPlant', InspectionOperation, 'Edm.String')

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

Static INSPECTION_SUB_SYSTEM

INSPECTION_SUB_SYSTEM: StringField<InspectionOperation> = new StringField('InspectionSubSystem', InspectionOperation, 'Edm.String')

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

Static INSP_PLAN_OPERATION_INTERNAL_ID

INSP_PLAN_OPERATION_INTERNAL_ID: StringField<InspectionOperation> = new StringField('InspPlanOperationInternalID', InspectionOperation, 'Edm.String')

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

Static OPERATION_CONFIRMATION

OPERATION_CONFIRMATION: StringField<InspectionOperation> = new StringField('OperationConfirmation', InspectionOperation, 'Edm.String')

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

Static OPERATION_CONTROL_PROFILE

OPERATION_CONTROL_PROFILE: StringField<InspectionOperation> = new StringField('OperationControlProfile', InspectionOperation, 'Edm.String')

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

Static OPERATION_TEXT

OPERATION_TEXT: StringField<InspectionOperation> = new StringField('OperationText', InspectionOperation, 'Edm.String')

Static representation of the operationText 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<InspectionOperation> = new StringField('OrderInternalBillOfOperations', InspectionOperation, '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 STATUS_OBJECT

STATUS_OBJECT: StringField<InspectionOperation> = new StringField('StatusObject', InspectionOperation, 'Edm.String')

Static representation of the statusObject 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<InspectionOperation> = new StringField('WorkCenterInternalID', InspectionOperation, '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<InspectionOperation>> = [InspectionOperation.INSPECTION_LOT,InspectionOperation.INSP_PLAN_OPERATION_INTERNAL_ID,InspectionOperation.ORDER_INTERNAL_BILL_OF_OPERATIONS,InspectionOperation.INSPECTION_OPERATION,InspectionOperation.INSPECTION_OPERATION_PLANT,InspectionOperation.BILL_OF_OPERATIONS_TYPE,InspectionOperation.BOO_OPERATION_INTERNAL_ID,InspectionOperation.WORK_CENTER_INTERNAL_ID,InspectionOperation.STATUS_OBJECT,InspectionOperation.OPERATION_CONTROL_PROFILE,InspectionOperation.OPERATION_CONFIRMATION,InspectionOperation.INSPECTION_SUB_SYSTEM,InspectionOperation.OPERATION_TEXT]

All fields of the InspectionOperation entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_InspectionOperation"

Technical entity name for InspectionOperation.

Static _keyFields

_keyFields: Array<Selectable<InspectionOperation>> = [InspectionOperation.INSPECTION_LOT, InspectionOperation.INSP_PLAN_OPERATION_INTERNAL_ID]

All key fields of the InspectionOperation entity.

Static _keys

_keys: any = InspectionOperation._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

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

Static _serviceName

_serviceName: string = "API_INSPECTIONLOT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<InspectionOperation>

    A builder that constructs instances of entity type InspectionOperation.

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>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns InspectionOperationRequestBuilder

    A InspectionOperation request builder.