Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • Entity
    • InspectionMethod

Implements

Index

Constructors

constructor

  • Returns InspectionMethod

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 createdByUser

createdByUser: undefined | string

Name of User Who Created the Data Record. Name of the user who created this data record. The system automatically enters the user name. Maximum length: 12.

nullable

Optional creationDate

creationDate: Moment

Date on Which Data Record Was Created. Date on which the data record was created. The system enters the current system date.

nullable

Optional inspMethInformationField1

inspMethInformationField1: undefined | string

Text Line for Additional Information. This field is used to store information only. The system does not use the contents of this field. Its only purpose is to provide a place to store information that is relevant to an object, such as an inspection method or a master inspection characteristic. Maximum length: 10.

nullable

Optional inspMethInformationField2

inspMethInformationField2: undefined | string

Text Line for Additional Information. This field is used to store information only. The system does not use the contents of this field. Its only purpose is to provide a place to store information that is relevant to an object, such as an inspection method or a master inspection characteristic. Maximum length: 20.

nullable

Optional inspMethInformationField3

inspMethInformationField3: undefined | string

Text Line for Additional Information. This field is used to store information only. The system does not use the contents of this field. Its only purpose is to provide a place to store information that is relevant to an object, such as an inspection method or a master inspection characteristic. Maximum length: 40.

nullable

inspectionMethod

inspectionMethod: string

Inspection Method. Name that uniquely identifies an inspection method within a plant. An inspection method describes how to inspect an inspection characteristic. You can assign an inspection method to a master inspection characteristic or directly to an inspection characteristic in an inspection plan. Maximum length: 8.

inspectionMethodPlant

inspectionMethodPlant: string

Plant for Inspection Method. Key, that identifies a plant. For inspection methods this plant is the planning plant, in which the inspection method was created in QM. Maximum length: 4.

Optional inspectionMethodSearchField

inspectionMethodSearchField: undefined | string

Search Field. This field uses the search help to make it easier to find master data records. Enter a meaningful word or phrase in this language-independent field. The entry you make should be easy to remember and should identify the master data record uniquely. Maximum length: 40.

nullable

Optional inspectionMethodStatus

inspectionMethodStatus: undefined | string

Status of Master Record. Indicates the processing status of the master record; for example, created, released, blocked, marked for deletion. Maximum length: 1.

nullable

Optional inspectionMethodValidFromDate

inspectionMethodValidFromDate: Moment

Valid-From Date. Specifies the start date for the validity period of an object (such as material, BOM, or routing).

nullable

inspectionMethodVersion

inspectionMethodVersion: string

Version Number of the Inspection Method. Maximum length: 6.

Optional inspectorQualification

inspectorQualification: undefined | string

Inspector Qualification. Qualification that an inspector must have and, if necessary, validate in order to be able to conduct an inspection. This field has no controlling function. However, your entry is checked against a list of qualifications stored in the database.You can enter an inspector qualification in an inspection method, a master inspection characteristic, or a task list.If you use a master inspection characteristic in a task list that has an inspection method assigned, the inspector qualification defined in the inspection method is used in the task list. If there is no inspector qualification in the inspection method, the qualification is taken from the master inspection characteristic. Maximum length: 5.

nullable

Optional lastChangeDate

lastChangeDate: Moment

Date on Which Data Record Was Changed. Date on which the data record was last changed. The system enters the current system date.

nullable

Optional lastChangedByUser

lastChangedByUser: undefined | string

Name of User Who Last Changed Data Record. Name of the user who made the last change to this data record. Maximum length: 12.

nullable

Optional linkedSapObjectKey

linkedSapObjectKey: undefined | string

Linked Sap Object Key. Maximum length: 18.

nullable

Optional qltyMstrDataAuthorizationGroup

qltyMstrDataAuthorizationGroup: undefined | string

Authorization Group QM Basic Data. The basic data authorization group restricts user access to the Quality Management basic data. Objects and activities that are affected:Master inspection characteristic, inspection method:Creating with an authorization groupCreating a validity period with an authorization groupChangingDisplayingDeletingChanging authorization groupIncluding inspection method in master inspection characteristic or task listIncluding master inspection characteristic in task list, certificate profile, or material specificationChanging an unplanned characteristic in results recordingSample-drawing procedure:EditingEditing authorization groupIf you enter an authorization group for master data records, the system checks whether the user has access to the objects named above.If no authorization group is entered in the master record, no authorization check takes place.To pass the authorization check, the user must have authorization for master data, which contains the relevant authorization group as a field value. Maximum length: 8.

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

Static ALL_FIELDS

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

All fields selector.

Static CREATED_BY_USER

CREATED_BY_USER: StringField<InspectionMethod> = new StringField('CreatedByUser', InspectionMethod, '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<InspectionMethod> = new DateField('CreationDate', InspectionMethod, '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_METHOD

INSPECTION_METHOD: StringField<InspectionMethod> = new StringField('InspectionMethod', InspectionMethod, 'Edm.String')

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

Static INSPECTION_METHOD_PLANT

INSPECTION_METHOD_PLANT: StringField<InspectionMethod> = new StringField('InspectionMethodPlant', InspectionMethod, 'Edm.String')

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

Static INSPECTION_METHOD_SEARCH_FIELD

INSPECTION_METHOD_SEARCH_FIELD: StringField<InspectionMethod> = new StringField('InspectionMethodSearchField', InspectionMethod, 'Edm.String')

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

Static INSPECTION_METHOD_STATUS

INSPECTION_METHOD_STATUS: StringField<InspectionMethod> = new StringField('InspectionMethodStatus', InspectionMethod, 'Edm.String')

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

Static INSPECTION_METHOD_VALID_FROM_DATE

INSPECTION_METHOD_VALID_FROM_DATE: DateField<InspectionMethod> = new DateField('InspectionMethodValidFromDate', InspectionMethod, 'Edm.DateTime')

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

Static INSPECTION_METHOD_VERSION

INSPECTION_METHOD_VERSION: StringField<InspectionMethod> = new StringField('InspectionMethodVersion', InspectionMethod, 'Edm.String')

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

Static INSPECTOR_QUALIFICATION

INSPECTOR_QUALIFICATION: StringField<InspectionMethod> = new StringField('InspectorQualification', InspectionMethod, 'Edm.String')

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

Static INSP_METH_INFORMATION_FIELD_1

INSP_METH_INFORMATION_FIELD_1: StringField<InspectionMethod> = new StringField('InspMethInformationField1', InspectionMethod, 'Edm.String')

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

Static INSP_METH_INFORMATION_FIELD_2

INSP_METH_INFORMATION_FIELD_2: StringField<InspectionMethod> = new StringField('InspMethInformationField2', InspectionMethod, 'Edm.String')

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

Static INSP_METH_INFORMATION_FIELD_3

INSP_METH_INFORMATION_FIELD_3: StringField<InspectionMethod> = new StringField('InspMethInformationField3', InspectionMethod, 'Edm.String')

Static representation of the inspMethInformationField3 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<InspectionMethod> = new StringField('LastChangedByUser', InspectionMethod, '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<InspectionMethod> = new DateField('LastChangeDate', InspectionMethod, '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 LINKED_SAP_OBJECT_KEY

LINKED_SAP_OBJECT_KEY: StringField<InspectionMethod> = new StringField('LinkedSAPObjectKey', InspectionMethod, 'Edm.String')

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

Static QLTY_MSTR_DATA_AUTHORIZATION_GROUP

QLTY_MSTR_DATA_AUTHORIZATION_GROUP: StringField<InspectionMethod> = new StringField('QltyMstrDataAuthorizationGroup', InspectionMethod, 'Edm.String')

Static representation of the qltyMstrDataAuthorizationGroup 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<InspectionMethod> | DateField<InspectionMethod>> = [InspectionMethod.INSPECTION_METHOD,InspectionMethod.INSPECTION_METHOD_VERSION,InspectionMethod.INSPECTION_METHOD_PLANT,InspectionMethod.INSPECTION_METHOD_VALID_FROM_DATE,InspectionMethod.INSPECTION_METHOD_SEARCH_FIELD,InspectionMethod.INSPECTION_METHOD_STATUS,InspectionMethod.INSP_METH_INFORMATION_FIELD_1,InspectionMethod.INSP_METH_INFORMATION_FIELD_2,InspectionMethod.INSP_METH_INFORMATION_FIELD_3,InspectionMethod.QLTY_MSTR_DATA_AUTHORIZATION_GROUP,InspectionMethod.INSPECTOR_QUALIFICATION,InspectionMethod.CREATED_BY_USER,InspectionMethod.CREATION_DATE,InspectionMethod.LAST_CHANGED_BY_USER,InspectionMethod.LAST_CHANGE_DATE,InspectionMethod.LINKED_SAP_OBJECT_KEY]

All fields of the InspectionMethod entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_InspectionMethod"

Technical entity name for InspectionMethod.

Static _keyFields

_keyFields: Array<Selectable<InspectionMethod>> = [InspectionMethod.INSPECTION_METHOD, InspectionMethod.INSPECTION_METHOD_VERSION, InspectionMethod.INSPECTION_METHOD_PLANT]

All key fields of the InspectionMethod entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_INSPECTIONMETHOD_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<InspectionMethod>

    A builder that constructs instances of entity type InspectionMethod.

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

    Returns InspectionMethodRequestBuilder

    A InspectionMethod request builder.