Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_InspPlanOperation" of service "API_INSPECTIONPLAN_SRV". This service is part of the following communication scenarios: Inspection Master Data Integration (SAP_COM_0110). See https://api.sap.com/api/API_INSPECTIONPLAN_SRV for more information.

Hierarchy

  • Entity
    • InspPlanOperation

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns InspPlanOperation

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 billOfOperationsRefGroup

billOfOperationsRefGroup: undefined | string

Referenced Bill of Operations Group. Maximum length: 8.

nullable

Optional billOfOperationsRefType

billOfOperationsRefType: undefined | string

Type of the referenced task list. Maximum length: 1.

nullable

Optional billOfOperationsRefVariant

billOfOperationsRefVariant: undefined | string

Referenced Bill of Operations Variant. Maximum length: 2.

nullable

booOpInternalVersionCounter

booOpInternalVersionCounter: string

Internal counter. Identifies the activity posting. Maximum length: 8.

booOperationInternalId

booOperationInternalId: string

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

Optional changeNumber

changeNumber: undefined | string

Change Number. Maximum length: 12.

nullable

Optional changedDateTime

changedDateTime: Moment

UTC Time Stamp in Short Form (YYYYMMDDhhmmss). The UTC time stamp is the date and time relative to UTC (Universal Coordinated Time). To standardize local times in a UTC time stamp and thus make them comparable with other times, these local times need to be converted using your time zone and the ABAP command convert.Even if the system is able to determine the time zone from Customizing or master data, you shoul save the time zone redundantly here.The internal structure of the UTC time stamp is subdivided into a date part and a time part in packed number format <YYYYMMDDhhmmss>. You can also use the high resolution UTC time stamp (10^-7 seconds).

nullable

Optional createdByUser

createdByUser: undefined | string

Created By User. Maximum length: 12.

nullable

Optional creationDate

creationDate: Moment

Date Record Created On. Date on which the record was created.

nullable

Optional inspResultRecordingView

inspResultRecordingView: undefined | string

Recording View. You use the recording view to specify different characteristic overview screens, which are called up after entering the results recording function. If the field is blank, the system uses the Single Values and Summarized Results view as the default overview screen.In results recording, you can change the settings for the recording view.In results recording, the default overview is called up if the system cannot call up a recording view that has been set.The recording view that has been set for an operation in the task list, has priority over a setting that is based on the inspection type. Maximum length: 2.

nullable

Optional inspSbstCompletionConfirmation

inspSbstCompletionConfirmation: undefined | string

Flow Variants for Inspection Point Completion. In this list field, you can choose one of the following variants for inspection point completion: Variant 1: Quantity, Valuation, and Confirmation (Production)The valuation screen for the inspection point is either opened automatically after the inspection characteristics have been closed when you exit the characteristic overview screen, or you can open the screen manually using the function key.You must assign a quantity and valuation to the inspection point.Depending on the control key used for the operation, the system proposes a confirmation indicator (for example, partial confirmation, final confirmation, or "no confirmation" for the order)Variant 2: Quantity, Valuation (Production)The valuation screen for the inspection point is opened automatically after the inspection characteristics have been closed, or you can call up the screen manually using the function key.You must assign a quantity and valuation to the inspection point.The confirmation indicator is set to "No confirmation". However, you can activate the confirmation despite this setting if you have set the control key accordingly.Variant 3: ValuationThe valuation screen for the inspection point is opened automatically after the inspection characteristics have been closed, or you can open the screen manually using the function key.You must only assign a valuation to the inspection point.Variant 4: Automatic Valuation Based on Inspection Point DefinitionThe valuation screen for the inspection point is not opened after the inspection characteristics have been closed.The inspection point is valuated automatically using the inspection point definition.If all the inspection characteristics are accepted, the acceptance valuation code is used.If one or more inspection characteristics were rejected, the rejection valuation code is used.NoteThe valuation screen is always opened if you:Defined a partial lot assignment in the task list headerUse the function key to call it up manuallyAssign the relevant variants to the inspections:Variants 1 to 4For an inspection during production: Variants 2 and 3 allow you to call up the confirmation transaction separately.Variants 3 or 4For maintenance orders: You can call up the confirmation transaction separately when you are on the valuation screen.For sample processing: No confirmation is defined for this case. Maximum length: 1.

nullable

Optional inspSbstHasNoTimeOrQuantity

inspSbstHasNoTimeOrQuantity: undefined | string

Interval Without Reference to Time or Quantity. If this indicator is set, inspection points are to be created but without any reference to quantity or time. Maximum length: 1.

nullable

inspectionPlan

inspectionPlan: string

Group Counter. This key and the task list group uniquely identify a task list. In Production Planning and Control, for example, it serves to identify alternative production processes in task lists and is used to make a distinction between similar task lists.The group counter can be used to identify different lot-size ranges, for example. Maximum length: 2.

inspectionPlanGroup

inspectionPlanGroup: string

Key for Task List Group. Key identifying a group. You can use groups, for instance, to identify two routings that have different production steps for one material.Enter the group to which you want to restrict the selection. Maximum length: 8.

inspectionPlanInternalVersion

inspectionPlanInternalVersion: string

Internal counter. Identifies the activity posting. Maximum length: 8.

Optional isDeleted

isDeleted: undefined | false | true

Deletion Indicator. Indicator showing that the BOM header or the BOM item has been deleted with reference to the change number. This indicator is relevant to changes that have been made with reference to a change number with a validity that has been specified using a new validity type.

nullable

Optional isImplicitlyDeleted

isImplicitlyDeleted: undefined | false | true

Deletion Indicator. Indicator showing that the BOM header or the BOM item has been deleted with reference to the change number. This indicator is relevant to changes that have been made with reference to a change number with a validity that has been specified using a new validity type.

nullable

Optional lastChangeDate

lastChangeDate: Moment

Date of Last Change.

nullable

Optional lastChangedByUser

lastChangedByUser: undefined | string

Last Changed By User. Maximum length: 12.

nullable

Optional opQtyToBaseQtyDnmntr

opQtyToBaseQtyDnmntr: BigNumber

Denominator for converting rtg and op units of measure. Denominator for the quotient that gives you the relation between the routing unit of measure and the operation unit of measure. For example, if the routing unit of measure is "piece" and the operation unit of measure "kilogram" and for every 5 kg there are 3 pieces, then the quotient is 3/5, because one kilogram is 3/5 of a piece.

nullable

Optional opQtyToBaseQtyNmrtr

opQtyToBaseQtyNmrtr: BigNumber

Numerator for Converting Routing and Operation UoM. Numerator for the quotient that tells you the relation between the routing unit of measure and the operation unit of measure. For example, if the routing unit of measure is "piece" and the operation unit of measure "kilogram" and for every 5 kgs there are 3 pieces, then the quotient is 3/5, because one kilogram is 3/5 of a piece.

nullable

Optional operation

operation: undefined | 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 operationControlProfile

operationControlProfile: undefined | 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 operationExternalId

operationExternalId: undefined | string

External operation ID. Maximum length: 8.

nullable

Optional operationReferenceQuantity

operationReferenceQuantity: BigNumber

Base Quantity. Quantity of the material to be produced to which the standard values of the operation refer.

nullable

Optional operationStandardTextCode

operationStandardTextCode: undefined | string

Standard Text Key. Key which identifies a text that is frequently used to describe certain processes (for example, turning or milling). You can assign a standard text to an operation by entering the standard text key in the operation. By changing this text within the operation long text, you can then create an individual operation description.Standard texts can also be assigned to network activities. Maximum length: 7.

nullable

Optional operationText

operationText: undefined | 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 operationUnit

operationUnit: undefined | string

Unit of Measure for Activity/Operation. Unit of measure used in the operation for the material to be produced. Among other things, it is valid for:the base quantitythe minimum lot sizethe minimum send-ahead quantity when operations overlapThe operation unit of measure can deviate from the unit of measure for the task list if you change the numerator and denominator in the quotient for conversion.If the unit of measure in the header has already been maintained, this unit is used as a default value for the operation unit. You can change the unit of measure in the operation. Maximum length: 3.

nullable

Optional plant

plant: undefined | string

Plant. Key uniquely identifying a plant. 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 validityEndDate

validityEndDate: Moment

Valid-To Date.

nullable

Optional validityStartDate

validityStartDate: Moment

Valid-From Date.

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: undefined | string

Object ID. Contains a unique eight-digit numerical code, that represents a specific object (for example, an organizational unit, qualification or business event). When you work with infotype records, this field allows you to use the Fast entry feature. Fast entry enables you to create numerous infotype records without having to exit and re-enter the infotype window.To select the object that the infotype record should belong to, either:Enter the object's eight-digit codeUse the matchcode feature to search for the object. 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<InspPlanOperation> = new AllFields('*', InspPlanOperation)

All fields selector.

Static BILL_OF_OPERATIONS_REF_GROUP

BILL_OF_OPERATIONS_REF_GROUP: StringField<InspPlanOperation> = new StringField('BillOfOperationsRefGroup', InspPlanOperation, 'Edm.String')

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

Static BILL_OF_OPERATIONS_REF_TYPE

BILL_OF_OPERATIONS_REF_TYPE: StringField<InspPlanOperation> = new StringField('BillOfOperationsRefType', InspPlanOperation, 'Edm.String')

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

Static BILL_OF_OPERATIONS_REF_VARIANT

BILL_OF_OPERATIONS_REF_VARIANT: StringField<InspPlanOperation> = new StringField('BillOfOperationsRefVariant', InspPlanOperation, 'Edm.String')

Static representation of the billOfOperationsRefVariant 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<InspPlanOperation> = new StringField('BOOOperationInternalID', InspPlanOperation, '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 BOO_OP_INTERNAL_VERSION_COUNTER

BOO_OP_INTERNAL_VERSION_COUNTER: StringField<InspPlanOperation> = new StringField('BOOOpInternalVersionCounter', InspPlanOperation, 'Edm.String')

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

Static CHANGED_DATE_TIME

CHANGED_DATE_TIME: DateField<InspPlanOperation> = new DateField('ChangedDateTime', InspPlanOperation, 'Edm.DateTimeOffset')

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

Static CHANGE_NUMBER

CHANGE_NUMBER: StringField<InspPlanOperation> = new StringField('ChangeNumber', InspPlanOperation, 'Edm.String')

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

Static CREATED_BY_USER

CREATED_BY_USER: StringField<InspPlanOperation> = new StringField('CreatedByUser', InspPlanOperation, 'Edm.String')

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

Static CREATION_DATE

CREATION_DATE: DateField<InspPlanOperation> = new DateField('CreationDate', InspPlanOperation, 'Edm.DateTime')

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

Static INSPECTION_PLAN

INSPECTION_PLAN: StringField<InspPlanOperation> = new StringField('InspectionPlan', InspPlanOperation, 'Edm.String')

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

Static INSPECTION_PLAN_GROUP

INSPECTION_PLAN_GROUP: StringField<InspPlanOperation> = new StringField('InspectionPlanGroup', InspPlanOperation, 'Edm.String')

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

Static INSPECTION_PLAN_INTERNAL_VERSION

INSPECTION_PLAN_INTERNAL_VERSION: StringField<InspPlanOperation> = new StringField('InspectionPlanInternalVersion', InspPlanOperation, 'Edm.String')

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

Static INSP_RESULT_RECORDING_VIEW

INSP_RESULT_RECORDING_VIEW: StringField<InspPlanOperation> = new StringField('InspResultRecordingView', InspPlanOperation, 'Edm.String')

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

Static INSP_SBST_COMPLETION_CONFIRMATION

INSP_SBST_COMPLETION_CONFIRMATION: StringField<InspPlanOperation> = new StringField('InspSbstCompletionConfirmation', InspPlanOperation, 'Edm.String')

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

Static INSP_SBST_HAS_NO_TIME_OR_QUANTITY

INSP_SBST_HAS_NO_TIME_OR_QUANTITY: StringField<InspPlanOperation> = new StringField('InspSbstHasNoTimeOrQuantity', InspPlanOperation, 'Edm.String')

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

Static IS_DELETED

IS_DELETED: BooleanField<InspPlanOperation> = new BooleanField('IsDeleted', InspPlanOperation, 'Edm.Boolean')

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

Static IS_IMPLICITLY_DELETED

IS_IMPLICITLY_DELETED: BooleanField<InspPlanOperation> = new BooleanField('IsImplicitlyDeleted', InspPlanOperation, 'Edm.Boolean')

Static representation of the isImplicitlyDeleted 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<InspPlanOperation> = new StringField('LastChangedByUser', InspPlanOperation, '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 LAST_CHANGE_DATE

LAST_CHANGE_DATE: DateField<InspPlanOperation> = new DateField('LastChangeDate', InspPlanOperation, 'Edm.DateTime')

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

Static OPERATION

OPERATION: StringField<InspPlanOperation> = new StringField('Operation', InspPlanOperation, 'Edm.String')

Static representation of the operation 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<InspPlanOperation> = new StringField('OperationControlProfile', InspPlanOperation, '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_EXTERNAL_ID

OPERATION_EXTERNAL_ID: StringField<InspPlanOperation> = new StringField('OperationExternalID', InspPlanOperation, 'Edm.String')

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

Static OPERATION_REFERENCE_QUANTITY

OPERATION_REFERENCE_QUANTITY: BigNumberField<InspPlanOperation> = new BigNumberField('OperationReferenceQuantity', InspPlanOperation, 'Edm.Decimal')

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

Static OPERATION_STANDARD_TEXT_CODE

OPERATION_STANDARD_TEXT_CODE: StringField<InspPlanOperation> = new StringField('OperationStandardTextCode', InspPlanOperation, 'Edm.String')

Static representation of the operationStandardTextCode 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<InspPlanOperation> = new StringField('OperationText', InspPlanOperation, '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 OPERATION_UNIT

OPERATION_UNIT: StringField<InspPlanOperation> = new StringField('OperationUnit', InspPlanOperation, '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_QTY_TO_BASE_QTY_DNMNTR

OP_QTY_TO_BASE_QTY_DNMNTR: BigNumberField<InspPlanOperation> = new BigNumberField('OpQtyToBaseQtyDnmntr', InspPlanOperation, 'Edm.Decimal')

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

Static OP_QTY_TO_BASE_QTY_NMRTR

OP_QTY_TO_BASE_QTY_NMRTR: BigNumberField<InspPlanOperation> = new BigNumberField('OpQtyToBaseQtyNmrtr', InspPlanOperation, 'Edm.Decimal')

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

Static PLANT

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

VALIDITY_END_DATE: DateField<InspPlanOperation> = new DateField('ValidityEndDate', InspPlanOperation, 'Edm.DateTime')

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

Static VALIDITY_START_DATE

VALIDITY_START_DATE: DateField<InspPlanOperation> = new DateField('ValidityStartDate', InspPlanOperation, 'Edm.DateTime')

Static representation of the validityStartDate 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<InspPlanOperation> = new StringField('WorkCenterInternalID', InspPlanOperation, '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<InspPlanOperation> = new StringField('WorkCenterTypeCode', InspPlanOperation, '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<InspPlanOperation> | BooleanField<InspPlanOperation> | BigNumberField<InspPlanOperation> | DateField<InspPlanOperation>> = [InspPlanOperation.INSPECTION_PLAN_GROUP,InspPlanOperation.BOO_OPERATION_INTERNAL_ID,InspPlanOperation.INSPECTION_PLAN_INTERNAL_VERSION,InspPlanOperation.BOO_OP_INTERNAL_VERSION_COUNTER,InspPlanOperation.INSPECTION_PLAN,InspPlanOperation.WORK_CENTER_INTERNAL_ID,InspPlanOperation.WORK_CENTER_TYPE_CODE,InspPlanOperation.IS_DELETED,InspPlanOperation.IS_IMPLICITLY_DELETED,InspPlanOperation.OPERATION_EXTERNAL_ID,InspPlanOperation.OPERATION,InspPlanOperation.OPERATION_TEXT,InspPlanOperation.PLANT,InspPlanOperation.OPERATION_CONTROL_PROFILE,InspPlanOperation.OPERATION_STANDARD_TEXT_CODE,InspPlanOperation.BILL_OF_OPERATIONS_REF_TYPE,InspPlanOperation.BILL_OF_OPERATIONS_REF_GROUP,InspPlanOperation.BILL_OF_OPERATIONS_REF_VARIANT,InspPlanOperation.INSP_RESULT_RECORDING_VIEW,InspPlanOperation.INSP_SBST_COMPLETION_CONFIRMATION,InspPlanOperation.INSP_SBST_HAS_NO_TIME_OR_QUANTITY,InspPlanOperation.OPERATION_REFERENCE_QUANTITY,InspPlanOperation.OPERATION_UNIT,InspPlanOperation.OP_QTY_TO_BASE_QTY_DNMNTR,InspPlanOperation.OP_QTY_TO_BASE_QTY_NMRTR,InspPlanOperation.CREATION_DATE,InspPlanOperation.CREATED_BY_USER,InspPlanOperation.LAST_CHANGE_DATE,InspPlanOperation.LAST_CHANGED_BY_USER,InspPlanOperation.CHANGED_DATE_TIME,InspPlanOperation.CHANGE_NUMBER,InspPlanOperation.VALIDITY_START_DATE,InspPlanOperation.VALIDITY_END_DATE]

All fields of the InspPlanOperation entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_InspPlanOperation"

Technical entity name for InspPlanOperation.

Static _keyFields

_keyFields: Array<Selectable<InspPlanOperation>> = [InspPlanOperation.INSPECTION_PLAN_GROUP, InspPlanOperation.BOO_OPERATION_INTERNAL_ID, InspPlanOperation.INSPECTION_PLAN_INTERNAL_VERSION, InspPlanOperation.BOO_OP_INTERNAL_VERSION_COUNTER, InspPlanOperation.INSPECTION_PLAN]

All key fields of the InspPlanOperation entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_INSPECTIONPLAN_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<InspPlanOperation>

    A builder that constructs instances of entity type InspPlanOperation.

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

    Returns InspPlanOperationRequestBuilder

    A InspPlanOperation request builder.