Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ProductPlantQualityMgmt" of service "API_PRODUCT_SRV". This service is part of the following communication scenarios: Product Integration (SAP_COM_0009), Distributed Manufacturing Integration (SAP_COM_0077), SAP Analytics Cloud for Planning Integration (SAP_COM_0087). See https://api.sap.com/api/API_PRODUCT_SRV for more information.

Hierarchy

  • Entity
    • ProductPlantQualityMgmt

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 hasPostToInspectionStock

hasPostToInspectionStock: undefined | false | true

Has Post to Inspection Stock. Specifies whether the product is subject to quality inspection (without inspection lot processing) and whether a goods receipt is posted to inspection stock. The indicator is copied to purchase order items and goods receipt items as a default value. You can select this indicator, if no stock-relevant inspection type has been selected in the inspection setup, and therefore no stock-relevant inspection lots can be created.If you activate a stock-relevant inspection type, the entry in this field is deselected and can no longer be maintained. In this case, a corresponding indicator in the inspection type controls whether goods are posted to inspection stock.

nullable

Optional matlQualityAuthorizationGroup

matlQualityAuthorizationGroup: undefined | string

Material Authorization Group for Activities in QM. The material authorization group restricts user access to material-related data in QM. Relevant objects and activities in QM:Changing the material authorization group in the QM material masterIf you want to change the authorization group, you require the relevant authorization for this group.Maintaining the material specificationProcessing inspection lotsProcessing inspection results (characteristic inspection results and defects data)Processing completion of the inspection and usage decisionMaintaining the quality levelMaintaining the quality information recordsWhen you enter a material authorization group in the material master record, the system checks (on a material basis) if the user has authorization for the objects named above.If there is no authorization group entered, no authorization check is carried out.In order to pass the authorization check, the user needs material authorization, which contains the relevant authorization group as the field value.Using the material authorization group, you can control which approvals should be issued during inspection lot processing. Maximum length: 6.

nullable

Optional maximumStoragePeriod

maximumStoragePeriod: BigNumber

Maximum Storage Period. The longest amount of time allowed for storing the material. The value displayed here is for informational purposes only. The field has no functional importance; in particular, there is no functional connection between this and the following fields:Minimum Remaining Shelf LifeTotal Shelf LifeStorage Percentage.

nullable

plant

plant: string

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

product

product: string

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

Optional qualityMgmtCtrlKey

qualityMgmtCtrlKey: undefined | string

Control Key for Quality Management in Procurement. This key determines which conditions are valid for quality management in procurement. If you activate the indicator for QM in procurement in the material master record at the client level, you must also store a control key at the plant level for quality management in procurement.Depending on the control indicators in the control key, you may have to maintain additional data. 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

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

All fields selector.

Static HAS_POST_TO_INSPECTION_STOCK

HAS_POST_TO_INSPECTION_STOCK: BooleanField<ProductPlantQualityMgmt> = new BooleanField('HasPostToInspectionStock', ProductPlantQualityMgmt, 'Edm.Boolean')

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

Static MATL_QUALITY_AUTHORIZATION_GROUP

MATL_QUALITY_AUTHORIZATION_GROUP: StringField<ProductPlantQualityMgmt> = new StringField('MatlQualityAuthorizationGroup', ProductPlantQualityMgmt, 'Edm.String')

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

Static MAXIMUM_STORAGE_PERIOD

MAXIMUM_STORAGE_PERIOD: BigNumberField<ProductPlantQualityMgmt> = new BigNumberField('MaximumStoragePeriod', ProductPlantQualityMgmt, 'Edm.Decimal')

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

Static PLANT

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

PRODUCT: StringField<ProductPlantQualityMgmt> = new StringField('Product', ProductPlantQualityMgmt, 'Edm.String')

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

Static QUALITY_MGMT_CTRL_KEY

QUALITY_MGMT_CTRL_KEY: StringField<ProductPlantQualityMgmt> = new StringField('QualityMgmtCtrlKey', ProductPlantQualityMgmt, 'Edm.String')

Static representation of the qualityMgmtCtrlKey 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<ProductPlantQualityMgmt> | BigNumberField<ProductPlantQualityMgmt> | BooleanField<ProductPlantQualityMgmt>> = [ProductPlantQualityMgmt.PRODUCT,ProductPlantQualityMgmt.PLANT,ProductPlantQualityMgmt.MAXIMUM_STORAGE_PERIOD,ProductPlantQualityMgmt.QUALITY_MGMT_CTRL_KEY,ProductPlantQualityMgmt.MATL_QUALITY_AUTHORIZATION_GROUP,ProductPlantQualityMgmt.HAS_POST_TO_INSPECTION_STOCK]

All fields of the ProductPlantQualityMgmt entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ProductPlantQualityMgmt"

Technical entity name for ProductPlantQualityMgmt.

Static _keyFields

_keyFields: Array<Selectable<ProductPlantQualityMgmt>> = [ProductPlantQualityMgmt.PRODUCT, ProductPlantQualityMgmt.PLANT]

All key fields of the ProductPlantQualityMgmt entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PRODUCT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProductPlantQualityMgmt>

    A builder that constructs instances of entity type ProductPlantQualityMgmt.

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

    Returns ProductPlantQualityMgmtRequestBuilder

    A ProductPlantQualityMgmt request builder.