Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_InspPlanMaterialAssgmt" 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
    • InspPlanMaterialAssgmt

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 booSearchText

booSearchText: undefined | string

Search Field for Customer-Specific Task List Selection. You can use this search field to control task list selection in the inspection lot. To do this, when you select a task list in the inspection lot, you can use a customer exit to define your own specific determination sequence for the search field. You can also use this customer exit to define a default value for this search field and a self-programmed F4-Help function for use within task list maintenance. Maximum length: 20.

nullable

Optional changeNumber

changeNumber: undefined | string

Change Number. Number used to uniquely identify a change master record. If you make a change with reference to a change number, or create anobject with a change number, the following functions are at your disposal:The system determines the effectivity parametersThe conditions that the change is effective under can be defined in the change master record as follows:Changes with a date effectivity (valid from date)Changes with parameter effectivity (for example: serial no. effectivity)Log of the changes madeDocumentation for the changesRevision level to indicate the change status of a material or documentChanges released for the different areas in the company. 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 customer

customer: undefined | string

Account number of customer. Uniquely identifies a customer. You use this for the number of a customer, for whom customer special stock is managed. Maximum length: 10.

nullable

inspPlanMatlAssgmtIntVersion

inspPlanMatlAssgmtIntVersion: string

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

inspPlanMatlAssignment

inspPlanMatlAssignment: string

Counter for additional criteria. Maximum length: 7.

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.

Optional inspectionPlanInternalVersion

inspectionPlanInternalVersion: undefined | string

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

nullable

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 lastChangeDate

lastChangeDate: Moment

Date of Last Change.

nullable

Optional lastChangedByUser

lastChangedByUser: undefined | string

Last Changed By User. Maximum length: 12.

nullable

material

material: string

Material Number. Alphanumeric key uniquely identifying the material. Maximum length: 40.

plant

plant: string

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

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 supplier

supplier: undefined | string

Vendor Account Number. Alphanumeric key uniquely identifying the document. With the supplier number, information from the supplier master record (such as the supplier's address and bank details) is copied into a purchasing document (such as a request for quotation or a purchase order).You can use the supplier number to keep track of requests for quotation, purchase orders and outline agreements. Maximum length: 10.

nullable

Optional validityEndDate

validityEndDate: Moment

Valid-to date. End of validity period of an object (such as material, BOM, or routing) in the SAP System.

nullable

Optional validityStartDate

validityStartDate: Moment

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

nullable

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

All fields selector.

Static BOO_SEARCH_TEXT

BOO_SEARCH_TEXT: StringField<InspPlanMaterialAssgmt> = new StringField('BOOSearchText', InspPlanMaterialAssgmt, 'Edm.String')

Static representation of the booSearchText 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<InspPlanMaterialAssgmt> = new DateField('ChangedDateTime', InspPlanMaterialAssgmt, '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<InspPlanMaterialAssgmt> = new StringField('ChangeNumber', InspPlanMaterialAssgmt, '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<InspPlanMaterialAssgmt> = new StringField('CreatedByUser', InspPlanMaterialAssgmt, '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<InspPlanMaterialAssgmt> = new DateField('CreationDate', InspPlanMaterialAssgmt, '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 CUSTOMER

CUSTOMER: StringField<InspPlanMaterialAssgmt> = new StringField('Customer', InspPlanMaterialAssgmt, 'Edm.String')

Static representation of the customer 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<InspPlanMaterialAssgmt> = new StringField('InspectionPlan', InspPlanMaterialAssgmt, '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<InspPlanMaterialAssgmt> = new StringField('InspectionPlanGroup', InspPlanMaterialAssgmt, '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<InspPlanMaterialAssgmt> = new StringField('InspectionPlanInternalVersion', InspPlanMaterialAssgmt, '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_PLAN_MATL_ASSGMT_INT_VERSION

INSP_PLAN_MATL_ASSGMT_INT_VERSION: StringField<InspPlanMaterialAssgmt> = new StringField('InspPlanMatlAssgmtIntVersion', InspPlanMaterialAssgmt, 'Edm.String')

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

Static INSP_PLAN_MATL_ASSIGNMENT

INSP_PLAN_MATL_ASSIGNMENT: StringField<InspPlanMaterialAssgmt> = new StringField('InspPlanMatlAssignment', InspPlanMaterialAssgmt, 'Edm.String')

Static representation of the inspPlanMatlAssignment 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<InspPlanMaterialAssgmt> = new BooleanField('IsDeleted', InspPlanMaterialAssgmt, '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 LAST_CHANGED_BY_USER

LAST_CHANGED_BY_USER: StringField<InspPlanMaterialAssgmt> = new StringField('LastChangedByUser', InspPlanMaterialAssgmt, '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<InspPlanMaterialAssgmt> = new DateField('LastChangeDate', InspPlanMaterialAssgmt, '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 MATERIAL

MATERIAL: StringField<InspPlanMaterialAssgmt> = new StringField('Material', InspPlanMaterialAssgmt, 'Edm.String')

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

Static PLANT

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

SUPPLIER: StringField<InspPlanMaterialAssgmt> = new StringField('Supplier', InspPlanMaterialAssgmt, 'Edm.String')

Static representation of the supplier 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<InspPlanMaterialAssgmt> = new DateField('ValidityEndDate', InspPlanMaterialAssgmt, '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<InspPlanMaterialAssgmt> = new DateField('ValidityStartDate', InspPlanMaterialAssgmt, '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 _allFields

_allFields: Array<StringField<InspPlanMaterialAssgmt> | DateField<InspPlanMaterialAssgmt> | BooleanField<InspPlanMaterialAssgmt>> = [InspPlanMaterialAssgmt.MATERIAL,InspPlanMaterialAssgmt.PLANT,InspPlanMaterialAssgmt.INSPECTION_PLAN_GROUP,InspPlanMaterialAssgmt.INSPECTION_PLAN,InspPlanMaterialAssgmt.INSP_PLAN_MATL_ASSIGNMENT,InspPlanMaterialAssgmt.INSP_PLAN_MATL_ASSGMT_INT_VERSION,InspPlanMaterialAssgmt.INSPECTION_PLAN_INTERNAL_VERSION,InspPlanMaterialAssgmt.VALIDITY_START_DATE,InspPlanMaterialAssgmt.VALIDITY_END_DATE,InspPlanMaterialAssgmt.CHANGE_NUMBER,InspPlanMaterialAssgmt.CREATION_DATE,InspPlanMaterialAssgmt.CREATED_BY_USER,InspPlanMaterialAssgmt.LAST_CHANGE_DATE,InspPlanMaterialAssgmt.LAST_CHANGED_BY_USER,InspPlanMaterialAssgmt.IS_DELETED,InspPlanMaterialAssgmt.SUPPLIER,InspPlanMaterialAssgmt.CUSTOMER,InspPlanMaterialAssgmt.BOO_SEARCH_TEXT,InspPlanMaterialAssgmt.CHANGED_DATE_TIME]

All fields of the InspPlanMaterialAssgmt entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_InspPlanMaterialAssgmt"

Technical entity name for InspPlanMaterialAssgmt.

Static _keyFields

_keyFields: Array<Selectable<InspPlanMaterialAssgmt>> = [InspPlanMaterialAssgmt.MATERIAL, InspPlanMaterialAssgmt.PLANT, InspPlanMaterialAssgmt.INSPECTION_PLAN_GROUP, InspPlanMaterialAssgmt.INSPECTION_PLAN, InspPlanMaterialAssgmt.INSP_PLAN_MATL_ASSIGNMENT, InspPlanMaterialAssgmt.INSP_PLAN_MATL_ASSGMT_INT_VERSION]

All key fields of the InspPlanMaterialAssgmt entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_INSPECTIONPLAN_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<InspPlanMaterialAssgmt>

    A builder that constructs instances of entity type InspPlanMaterialAssgmt.

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

    Returns InspPlanMaterialAssgmtRequestBuilder

    A InspPlanMaterialAssgmt request builder.