Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_InspectionLotWithStatus" 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
    • InspectionLotWithStatus

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 inspLotStatusCanceled

inspLotStatusCanceled: undefined | string

Insp Lot Status Canceled. Maximum length: 1.

nullable

Optional inspLotStatusInspCompleted

inspLotStatusInspCompleted: undefined | string

Insp Lot Status Insp Completed. Maximum length: 1.

nullable

Optional inspLotStatusRepair

inspLotStatusRepair: undefined | string

Insp Lot Status Repair. Maximum length: 1.

nullable

Optional inspLotStatusRsltsConfirmed

inspLotStatusRsltsConfirmed: undefined | string

Insp Lot Status Rslts Confirmed. Maximum length: 1.

nullable

Optional inspLotStsDefectsRecorded

inspLotStsDefectsRecorded: undefined | string

Insp Lot Sts Defects Recorded. Maximum length: 1.

nullable

Optional inspLotStsShrtTrmInspCmpltd

inspLotStsShrtTrmInspCmpltd: undefined | string

Insp Lot Sts Shrt Trm Insp Cmpltd. 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 inspectionLotStatusCreated

inspectionLotStatusCreated: undefined | string

Inspection Lot Status Created. Maximum length: 1.

nullable

Optional inspectionLotStatusReleased

inspectionLotStatusReleased: undefined | string

Inspection Lot Status Released. Maximum length: 1.

nullable

Optional inspectionLotStatusSkip

inspectionLotStatusSkip: undefined | string

Inspection Lot Status Skip. Maximum length: 1.

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<InspectionLotWithStatus> = new AllFields('*', InspectionLotWithStatus)

All fields selector.

Static INSPECTION_LOT

INSPECTION_LOT: StringField<InspectionLotWithStatus> = new StringField('InspectionLot', InspectionLotWithStatus, '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_LOT_STATUS_CREATED

INSPECTION_LOT_STATUS_CREATED: StringField<InspectionLotWithStatus> = new StringField('InspectionLotStatusCreated', InspectionLotWithStatus, 'Edm.String')

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

Static INSPECTION_LOT_STATUS_RELEASED

INSPECTION_LOT_STATUS_RELEASED: StringField<InspectionLotWithStatus> = new StringField('InspectionLotStatusReleased', InspectionLotWithStatus, 'Edm.String')

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

Static INSPECTION_LOT_STATUS_SKIP

INSPECTION_LOT_STATUS_SKIP: StringField<InspectionLotWithStatus> = new StringField('InspectionLotStatusSkip', InspectionLotWithStatus, 'Edm.String')

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

Static INSP_LOT_STATUS_CANCELED

INSP_LOT_STATUS_CANCELED: StringField<InspectionLotWithStatus> = new StringField('InspLotStatusCanceled', InspectionLotWithStatus, 'Edm.String')

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

Static INSP_LOT_STATUS_INSP_COMPLETED

INSP_LOT_STATUS_INSP_COMPLETED: StringField<InspectionLotWithStatus> = new StringField('InspLotStatusInspCompleted', InspectionLotWithStatus, 'Edm.String')

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

Static INSP_LOT_STATUS_REPAIR

INSP_LOT_STATUS_REPAIR: StringField<InspectionLotWithStatus> = new StringField('InspLotStatusRepair', InspectionLotWithStatus, 'Edm.String')

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

Static INSP_LOT_STATUS_RSLTS_CONFIRMED

INSP_LOT_STATUS_RSLTS_CONFIRMED: StringField<InspectionLotWithStatus> = new StringField('InspLotStatusRsltsConfirmed', InspectionLotWithStatus, 'Edm.String')

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

Static INSP_LOT_STS_DEFECTS_RECORDED

INSP_LOT_STS_DEFECTS_RECORDED: StringField<InspectionLotWithStatus> = new StringField('InspLotStsDefectsRecorded', InspectionLotWithStatus, 'Edm.String')

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

Static INSP_LOT_STS_SHRT_TRM_INSP_CMPLTD

INSP_LOT_STS_SHRT_TRM_INSP_CMPLTD: StringField<InspectionLotWithStatus> = new StringField('InspLotStsShrtTrmInspCmpltd', InspectionLotWithStatus, 'Edm.String')

Static representation of the inspLotStsShrtTrmInspCmpltd 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<InspectionLotWithStatus>> = [InspectionLotWithStatus.INSPECTION_LOT,InspectionLotWithStatus.INSPECTION_LOT_STATUS_CREATED,InspectionLotWithStatus.INSPECTION_LOT_STATUS_RELEASED,InspectionLotWithStatus.INSPECTION_LOT_STATUS_SKIP,InspectionLotWithStatus.INSP_LOT_STATUS_RSLTS_CONFIRMED,InspectionLotWithStatus.INSP_LOT_STS_DEFECTS_RECORDED,InspectionLotWithStatus.INSP_LOT_STS_SHRT_TRM_INSP_CMPLTD,InspectionLotWithStatus.INSP_LOT_STATUS_INSP_COMPLETED,InspectionLotWithStatus.INSP_LOT_STATUS_CANCELED,InspectionLotWithStatus.INSP_LOT_STATUS_REPAIR]

All fields of the InspectionLotWithStatus entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_InspectionLotWithStatus"

Technical entity name for InspectionLotWithStatus.

Static _keyFields

_keyFields: Array<Selectable<InspectionLotWithStatus>> = [InspectionLotWithStatus.INSPECTION_LOT]

All key fields of the InspectionLotWithStatus entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_INSPECTIONLOT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<InspectionLotWithStatus>

    A builder that constructs instances of entity type InspectionLotWithStatus.

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

    Returns InspectionLotWithStatusRequestBuilder

    A InspectionLotWithStatus request builder.