Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "HandlingUnitItem" of service "cds_api_handling_unit". This service is part of the following communication scenarios: Handling Unit Integration (SAP_COM_0364). See https://api.sap.com/api/API_HANDLING_UNIT for more information.

Hierarchy

  • Entity
    • HandlingUnitItem

Implements

Index

Constructors

constructor

  • Returns HandlingUnitItem

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 handlingUnitAltUnitOfMeasure

handlingUnitAltUnitOfMeasure: undefined | string

Alternative unit of measure for stock unit of measure. Unit of measure in which quantities can be entered as an alternative to the base unit of measure. Maximum length: 3.

nullable

handlingUnitExternalId

handlingUnitExternalId: string

External Handling Unit Identification. Specifies an external identifier for the handling unit. The system automatically generates an internal number that must be unique for each system client. The system also needs external identification so that it can uniquely identify handling units.Creating a handling unit:Identifiers for handling units are determined during creation according to settings in Customizing for number assignment of the packaging material type for the packaging material that is being used. You can also assign default values for identifiers when you create handling units, although these values must correspond to the settings in Customizing.Processing a handling unitTo edit existing handling units, enter the handling unit's identification in this field. Maximum length: 20.

Optional handlingUnitGoodsReceiptDate

handlingUnitGoodsReceiptDate: Moment

Date of Goods Receipt. Date of goods receipt of a material.

nullable

Optional handlingUnitQuantity

handlingUnitQuantity: BigNumber

Base Quantity Packed in the Handling Unit Item.

nullable

Optional handlingUnitQuantityUnit

handlingUnitQuantityUnit: undefined | string

Base Unit of Measure of the Quantity to be Packed (VEMNG). Maximum length: 3.

nullable

Optional handlingUnitRefDocumentItem

handlingUnitRefDocumentItem: undefined | string

Character Field with Length 10. Maximum length: 10.

nullable

Optional handlingUnitReferenceDocument

handlingUnitReferenceDocument: undefined | string

Delivery. The number that uniquely identifies the delivery. Maximum length: 10.

nullable

Optional material

material: undefined | string

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

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

Optional shelfLifeExpirationDate

shelfLifeExpirationDate: Moment

Shelf Life Expiration or Best-Before Date. The date is set upon goods receipt in one of the following ways: You enter it yourself.You enter a date of production, and the system calculates the shelf life expiration date from the date of production plus the shelf life in days (from the material master record).NoteThis date can still be changed upon receipt of the usage decision for an inspection lot.

nullable

stockItemUuid

stockItemUuid: string

GUID Stock Item.

toHandlingUnit

toHandlingUnit: HandlingUnit

One-to-one navigation property to the HandlingUnit entity.

warehouse

warehouse: string

Warehouse Number/Warehouse Complex. Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system. All activities within a warehouse, for example, goods movements and physical inventory, are assigned to a specific warehouse number. The physical warehouse where these activities take place is identified by the warehouse number. Maximum length: 4.

Static ALL_FIELDS

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

All fields selector.

Static HANDLING_UNIT_ALT_UNIT_OF_MEASURE

HANDLING_UNIT_ALT_UNIT_OF_MEASURE: StringField<HandlingUnitItem> = new StringField('HandlingUnitAltUnitOfMeasure', HandlingUnitItem, 'Edm.String')

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

Static HANDLING_UNIT_EXTERNAL_ID

HANDLING_UNIT_EXTERNAL_ID: StringField<HandlingUnitItem> = new StringField('HandlingUnitExternalID', HandlingUnitItem, 'Edm.String')

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

Static HANDLING_UNIT_GOODS_RECEIPT_DATE

HANDLING_UNIT_GOODS_RECEIPT_DATE: DateField<HandlingUnitItem> = new DateField('HandlingUnitGoodsReceiptDate', HandlingUnitItem, 'Edm.DateTime')

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

Static HANDLING_UNIT_QUANTITY

HANDLING_UNIT_QUANTITY: BigNumberField<HandlingUnitItem> = new BigNumberField('HandlingUnitQuantity', HandlingUnitItem, 'Edm.Decimal')

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

Static HANDLING_UNIT_QUANTITY_UNIT

HANDLING_UNIT_QUANTITY_UNIT: StringField<HandlingUnitItem> = new StringField('HandlingUnitQuantityUnit', HandlingUnitItem, 'Edm.String')

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

Static HANDLING_UNIT_REFERENCE_DOCUMENT

HANDLING_UNIT_REFERENCE_DOCUMENT: StringField<HandlingUnitItem> = new StringField('HandlingUnitReferenceDocument', HandlingUnitItem, 'Edm.String')

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

Static HANDLING_UNIT_REF_DOCUMENT_ITEM

HANDLING_UNIT_REF_DOCUMENT_ITEM: StringField<HandlingUnitItem> = new StringField('HandlingUnitRefDocumentItem', HandlingUnitItem, 'Edm.String')

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

Static MATERIAL

MATERIAL: StringField<HandlingUnitItem> = new StringField('Material', HandlingUnitItem, '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 SHELF_LIFE_EXPIRATION_DATE

SHELF_LIFE_EXPIRATION_DATE: DateField<HandlingUnitItem> = new DateField('ShelfLifeExpirationDate', HandlingUnitItem, 'Edm.DateTime')

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

Static STOCK_ITEM_UUID

STOCK_ITEM_UUID: StringField<HandlingUnitItem> = new StringField('StockItemUUID', HandlingUnitItem, 'Edm.Guid')

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

Static TO_HANDLING_UNIT

TO_HANDLING_UNIT: OneToOneLink<HandlingUnitItem, HandlingUnit> = new OneToOneLink('to_HandlingUnit', HandlingUnitItem, HandlingUnit)

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

Static WAREHOUSE

WAREHOUSE: StringField<HandlingUnitItem> = new StringField('Warehouse', HandlingUnitItem, 'Edm.String')

Static representation of the warehouse 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<HandlingUnitItem> | BigNumberField<HandlingUnitItem> | DateField<HandlingUnitItem> | OneToOneLink<HandlingUnitItem, HandlingUnit>> = [HandlingUnitItem.HANDLING_UNIT_EXTERNAL_ID,HandlingUnitItem.WAREHOUSE,HandlingUnitItem.STOCK_ITEM_UUID,HandlingUnitItem.HANDLING_UNIT_REFERENCE_DOCUMENT,HandlingUnitItem.HANDLING_UNIT_REF_DOCUMENT_ITEM,HandlingUnitItem.HANDLING_UNIT_QUANTITY,HandlingUnitItem.HANDLING_UNIT_QUANTITY_UNIT,HandlingUnitItem.HANDLING_UNIT_ALT_UNIT_OF_MEASURE,HandlingUnitItem.MATERIAL,HandlingUnitItem.SHELF_LIFE_EXPIRATION_DATE,HandlingUnitItem.HANDLING_UNIT_GOODS_RECEIPT_DATE,HandlingUnitItem.TO_HANDLING_UNIT]

All fields of the HandlingUnitItem entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "HandlingUnitItem"

Technical entity name for HandlingUnitItem.

Static _keyFields

_keyFields: Array<Selectable<HandlingUnitItem>> = [HandlingUnitItem.HANDLING_UNIT_EXTERNAL_ID, HandlingUnitItem.WAREHOUSE, HandlingUnitItem.STOCK_ITEM_UUID]

All key fields of the HandlingUnitItem entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "cds_api_handling_unit"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<HandlingUnitItem>

    A builder that constructs instances of entity type HandlingUnitItem.

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

    Returns HandlingUnitItemRequestBuilder

    A HandlingUnitItem request builder.