Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_InspSampleCharacteristic" 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
    • InspSampleCharacteristic

Implements

Index

Constructors

constructor

Properties

Protected _customFields

_customFields: MapType<any>

A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.

Protected _versionIdentifier

_versionIdentifier: string

The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".

Optional 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 inspLotDynRuleStage

inspLotDynRuleStage: string

Inspection Stage. In this field, you define the inspection stage. You define an inspection stage by assigning an inspection severity (or by setting the skip indicator) and using the rules for an inspection stage change. Therefore, inspection stages represent a certain inspection scope or a skip.Inspection stages are defined in a dynamic modification rule. Maximum length: 4.

nullable

inspPlanOperationInternalId

inspPlanOperationInternalId: string

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

Optional inspSampleAcceptanceNumber

inspSampleAcceptanceNumber: number

Acceptance Number. In this field you enter the highest number of nonconforming units or defects in a sample during a sampling inspection for an attributive inspection, that still permits acceptance of the inspection lot.

nullable

Optional inspSampleRejectionNumber

inspSampleRejectionNumber: number

Rejection Number. The lowest number of nonconforming units or defects in a sample that leads to a rejection during an attributive sampling inspection.

nullable

Optional inspSampleValuationRule

inspSampleValuationRule: string

Valuation Rule. Two-character key identifying a valuation rule that is used to valuate inspection characteristics, samples and partial samples. Maximum length: 2.

nullable

Optional inspSubsetCharcCreationDate

inspSubsetCharcCreationDate: Moment

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

nullable

inspectionCharacteristic

inspectionCharacteristic: string

Inspection Characteristic Number. The number that explicitly identifies an inspection characteristic within an operation in an inspection plan. Maximum length: 4.

Optional inspectionCharacteristicStatus

inspectionCharacteristicStatus: string

Specification Record Status. Specification status of the specification record for the inspection characteristic or the partial sample. The specification record documents whether youMust record results (required characteristic, record status = 1) for an inspection characteristic or partial sampleCan record results (optional characteristic, record status = 0) for an inspection characteristic or partial sampleSkip the inspection characteristic (record status = 4). Maximum length: 1.

nullable

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 inspectionSampleSize

inspectionSampleSize: number

Sample Size that Must Be Inspected. Predfined sample size that has to be inspected for the inspection characteristic or the partial sample. For each inspection plan characteristic you define the amount by which the inspected sample size in the 'Insp.ed' field can deviate from the to-be-inspected sample size in the 'Inspect' field. If a characteristic (partial sample ) is closed the system checks whether the required sample size is adhered to. The characteristic (partial sample) can only be closed if this is the case.For inspection characteristics, you can define conditions for adhering to the sample size. For example, you can define whether the inspection scope must be adhered to or whether it may be larger or smaller, etc.

nullable

Optional inspectionSeverity

inspectionSeverity: string

Inspection Severity. In the QM component, the inspection severity serves as an identifier for a normal, reduced, or tightened inspection. Different inspection severities lead to different inspection scopes if the other conditions are the same.It is advisable to use different inspection severities in the dynamic modification rule, if the dynamic modification rule is assigned to a sampling procedure that uses a sampling scheme in which these inspection severities are maintained. Maximum length: 3.

nullable

inspectionSubsetInternalId

inspectionSubsetInternalId: string

Inspection Sample Number. Number identifying an inspection sample if dependent or independent multiple samples are used in the sampling procedure of the characteristic or if inspection points are involved. Maximum length: 6.

Optional qualityControlChart

qualityControlChart: string

Control Chart Number. The number that uniquely identifies a quality control chart. Maximum length: 12.

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

Static ALL_FIELDS

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

All fields selector.

Static CHANGED_DATE_TIME

CHANGED_DATE_TIME: DateField<InspSampleCharacteristic> = new DateField('ChangedDateTime', InspSampleCharacteristic, '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 INSPECTION_CHARACTERISTIC

INSPECTION_CHARACTERISTIC: StringField<InspSampleCharacteristic> = new StringField('InspectionCharacteristic', InspSampleCharacteristic, 'Edm.String')

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

Static INSPECTION_CHARACTERISTIC_STATUS

INSPECTION_CHARACTERISTIC_STATUS: StringField<InspSampleCharacteristic> = new StringField('InspectionCharacteristicStatus', InspSampleCharacteristic, 'Edm.String')

Static representation of the inspectionCharacteristicStatus 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<InspSampleCharacteristic> = new StringField('InspectionLot', InspSampleCharacteristic, '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_SAMPLE_SIZE

INSPECTION_SAMPLE_SIZE: NumberField<InspSampleCharacteristic> = new NumberField('InspectionSampleSize', InspSampleCharacteristic, 'Edm.Int32')

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

Static INSPECTION_SEVERITY

INSPECTION_SEVERITY: StringField<InspSampleCharacteristic> = new StringField('InspectionSeverity', InspSampleCharacteristic, 'Edm.String')

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

Static INSPECTION_SUBSET_INTERNAL_ID

INSPECTION_SUBSET_INTERNAL_ID: StringField<InspSampleCharacteristic> = new StringField('InspectionSubsetInternalID', InspSampleCharacteristic, 'Edm.String')

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

Static INSP_LOT_DYN_RULE_STAGE

INSP_LOT_DYN_RULE_STAGE: StringField<InspSampleCharacteristic> = new StringField('InspLotDynRuleStage', InspSampleCharacteristic, 'Edm.String')

Static representation of the inspLotDynRuleStage 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<InspSampleCharacteristic> = new StringField('InspPlanOperationInternalID', InspSampleCharacteristic, '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 INSP_SAMPLE_ACCEPTANCE_NUMBER

INSP_SAMPLE_ACCEPTANCE_NUMBER: NumberField<InspSampleCharacteristic> = new NumberField('InspSampleAcceptanceNumber', InspSampleCharacteristic, 'Edm.Int16')

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

Static INSP_SAMPLE_REJECTION_NUMBER

INSP_SAMPLE_REJECTION_NUMBER: NumberField<InspSampleCharacteristic> = new NumberField('InspSampleRejectionNumber', InspSampleCharacteristic, 'Edm.Int16')

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

Static INSP_SAMPLE_VALUATION_RULE

INSP_SAMPLE_VALUATION_RULE: StringField<InspSampleCharacteristic> = new StringField('InspSampleValuationRule', InspSampleCharacteristic, 'Edm.String')

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

Static INSP_SUBSET_CHARC_CREATION_DATE

INSP_SUBSET_CHARC_CREATION_DATE: DateField<InspSampleCharacteristic> = new DateField('InspSubsetCharcCreationDate', InspSampleCharacteristic, 'Edm.DateTime')

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

Static QUALITY_CONTROL_CHART

QUALITY_CONTROL_CHART: StringField<InspSampleCharacteristic> = new StringField('QualityControlChart', InspSampleCharacteristic, 'Edm.String')

Static representation of the qualityControlChart 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<InspSampleCharacteristic> | NumberField<InspSampleCharacteristic> | DateField<InspSampleCharacteristic>> = [InspSampleCharacteristic.INSPECTION_LOT,InspSampleCharacteristic.INSP_PLAN_OPERATION_INTERNAL_ID,InspSampleCharacteristic.INSPECTION_CHARACTERISTIC,InspSampleCharacteristic.INSPECTION_SUBSET_INTERNAL_ID,InspSampleCharacteristic.INSPECTION_CHARACTERISTIC_STATUS,InspSampleCharacteristic.QUALITY_CONTROL_CHART,InspSampleCharacteristic.INSP_SAMPLE_ACCEPTANCE_NUMBER,InspSampleCharacteristic.INSP_SAMPLE_REJECTION_NUMBER,InspSampleCharacteristic.INSP_SAMPLE_VALUATION_RULE,InspSampleCharacteristic.INSPECTION_SAMPLE_SIZE,InspSampleCharacteristic.INSP_LOT_DYN_RULE_STAGE,InspSampleCharacteristic.INSPECTION_SEVERITY,InspSampleCharacteristic.INSP_SUBSET_CHARC_CREATION_DATE,InspSampleCharacteristic.CHANGED_DATE_TIME]

All fields of the InspSampleCharacteristic entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_InspSampleCharacteristic"

Technical entity name for InspSampleCharacteristic.

Static _keyFields

_keyFields: Array<Selectable<InspSampleCharacteristic>> = [InspSampleCharacteristic.INSPECTION_LOT, InspSampleCharacteristic.INSP_PLAN_OPERATION_INTERNAL_ID, InspSampleCharacteristic.INSPECTION_CHARACTERISTIC, InspSampleCharacteristic.INSPECTION_SUBSET_INTERNAL_ID]

All key fields of the InspSampleCharacteristic entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_INSPECTIONLOT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<InspSampleCharacteristic>

    A builder that constructs instances of entity type InspSampleCharacteristic.

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

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT, JsonT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns InspSampleCharacteristicRequestBuilder

    A InspSampleCharacteristic request builder.