Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns HandlingUnit

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 createdByUser

createdByUser: undefined | string

Name of Person Who Created Object. Maximum length: 12.

nullable

Optional creationDateTime

creationDateTime: BigNumber

Creation Date Time.

nullable

Optional grossVolume

grossVolume: BigNumber

Total Volume of Handling Unit. Specifies the total volume of the handling unit. Determination of the total volume depends on the packaging material.For open packaging materials, such as pallets, total volume is calculated from the tare volume of the packaging (=packaging materials) and the volume of the contents.For closed packaging materials, such as boxes with lids, the total volume is equal to the tare volume of the packaging.An indicator specifies whether the packaging material in question is open or closed.

nullable

Optional grossWeight

grossWeight: BigNumber

Total Weight of Handling Unit. Specifies the total weight of the handling unit. The total weight is calculated from the contents (the weight of the material items or the total weight of the lower-level handling units) plus the tare weight of the packaging material.

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 handlingUnitHeight

handlingUnitHeight: BigNumber

Height. Height of the material or its packaging, measured in the unit of dimension.

nullable

Optional handlingUnitLength

handlingUnitLength: BigNumber

Length. Length of the material or its packaging, measured in the unit of dimension.

nullable

Optional handlingUnitMaxWeight

handlingUnitMaxWeight: BigNumber

Allowed Loading Weight of a Handling Unit. Specifies the maximum loading weight that is allowed for this packaging material. The maximum weight of a handling unit is the sum of the tare weight and the maximum loading weight allowed, including excess weight tolerance. The system proposes the allowed loading weight from the material master. You can change the value manually in the handling unit.You can enter a tolerance limit for the maximum loading weight allowed for this packaging material.

nullable

Optional handlingUnitNetVolume

handlingUnitNetVolume: BigNumber

Loading Volume of Handling Unit. Specifies the total volume of the content of the handling unit. This volume is made up of the sum of the total volume of the lower-level handling units (if the handling unit contains other handling units) or the volume of the materials in the handling unit. The tare volume of the handling unit (=packaging material) is excluded.

nullable

Optional handlingUnitProcessStatus

handlingUnitProcessStatus: undefined | string

Handling Unit Process Status. Maximum length: 1.

nullable

Optional handlingUnitReferenceDocument

handlingUnitReferenceDocument: undefined | string

Sales and Distribution Document Number. The number that uniquely identifies the sales, delivery, or billing document. Maximum length: 10.

nullable

Optional handlingUnitTareVolume

handlingUnitTareVolume: BigNumber

Tare Volume of Handling Unit. Specifies the unloaded volume of the handling unit. The system automatically proposes the volume of the packaging material, which is taken from the material master record.The tare volume of a container is the volume of the container itself.

nullable

Optional handlingUnitTareVolumeUnit

handlingUnitTareVolumeUnit: undefined | string

Volume Unit. Unit referring to the volume of the material. If you specify a volume, you have to enter the corresponding volume unit here. Maximum length: 3.

nullable

Optional handlingUnitTareWeight

handlingUnitTareWeight: BigNumber

Tare Weight of Handling Unit. Specifies the unloaded weight of the handling unit. The system automatically proposes the gross weight of the packaging material from the material master record.The tare weight of a container would be the weight of the container itself (in other words, the total weight of the load minus the weight of the container's contents).

nullable

Optional handlingUnitTareWeightUnit

handlingUnitTareWeightUnit: undefined | string

Unit of Weight. Unit referring to the gross weight or net weight of the material. If you specify a weight, you must enter the corresponding unit of weight here. Maximum length: 3.

nullable

Optional handlingUnitWidth

handlingUnitWidth: BigNumber

Width. Breadth of the material or its packaging, measured in the unit of dimension.

nullable

Optional lastChangeDateTime

lastChangeDateTime: BigNumber

Last Change Date Time.

nullable

Optional lastChangedByUser

lastChangedByUser: undefined | string

Name of Person who Changed Object. Maximum length: 12.

nullable

Optional netWeight

netWeight: BigNumber

Loading Weight of Handling Unit. Specifies the total weight of the contents of a handling unit, excluding the tare weight of the handling unit (=packaging material).

nullable

Optional packagingMaterial

packagingMaterial: undefined | string

Packaging Materials. Specifies the means of packing (box, wooden pallet, container) that can be used to pack and transport goods. Data for each packaging material you use is stored in a material master record. When you specify a packaging material for a handling unit, the system automatically proposes default data from the corresponding material master record (maximum allowed weight and volume, for example). Maximum length: 18.

nullable

Optional packagingMaterialType

packagingMaterialType: undefined | string

Packaging Material Type. Enter a code and a description for a grouping of similar materials, such as crates, trucks or pallets. The packaging material type that you enter here is linked in Customizing to a material group for packaging materials, which you assign to a material in the material master. As you assemble the handling unit, you call up a list of packaging materials that are allowed for an item that you want to pack. This system puts together this list by matching the material group for packaging materials for that item with the appropriate packaging material types.Material group for packaging materials Packaging material types0001 Beverages 0010 Barrels0001 Beverages 0020 Bottles0002 Small parts 0030 Boxes0002 Small parts 0040 Plastic bags0003 Pallets 0050 Containers0003 Pallets 0060 TrucksDuring packing, when you call up the list of allowed packaging materials for a material defined in the material master as material group 0001 (beverages), the system lists all packaging materials of type 0010 (barrels) and 0020 (bottles). For group 0002 (small parts), packaging materials assigned to types 0030 (boxes) and 0040 (plastic bags) would be proposed and for group 0003, packaging materials of types 0050 (containers) and 0060 (trucks) would be proposed.The groupings and packaging material types are freely definable. Maximum length: 4.

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

toHandlingUnitItem

toHandlingUnitItem: HandlingUnitItem[]

One-to-many navigation property to the HandlingUnitItem entity.

Optional unitOfMeasureDimension

unitOfMeasureDimension: undefined | string

Unit of Dimension for Length/Width/Height. Unit in which the dimensions of length, breadth, and height of a material or its packaging are measured. Maximum length: 3.

nullable

Optional volumeUnit

volumeUnit: undefined | string

Volume Unit. Unit referring to the volume of the material. If you specify a volume, you have to enter the corresponding volume unit here. Maximum length: 3.

nullable

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.

Optional weightUnit

weightUnit: undefined | string

Unit of Weight. Unit referring to the gross weight or net weight of the material. If you specify a weight, you must enter the corresponding unit of weight here. Maximum length: 3.

nullable

Static ALL_FIELDS

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

All fields selector.

Static CREATED_BY_USER

CREATED_BY_USER: StringField<HandlingUnit> = new StringField('CreatedByUser', HandlingUnit, '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_TIME

CREATION_DATE_TIME: BigNumberField<HandlingUnit> = new BigNumberField('CreationDateTime', HandlingUnit, 'Edm.Decimal')

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

Static GROSS_VOLUME

GROSS_VOLUME: BigNumberField<HandlingUnit> = new BigNumberField('GrossVolume', HandlingUnit, 'Edm.Decimal')

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

Static GROSS_WEIGHT

GROSS_WEIGHT: BigNumberField<HandlingUnit> = new BigNumberField('GrossWeight', HandlingUnit, 'Edm.Decimal')

Static representation of the grossWeight 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<HandlingUnit> = new StringField('HandlingUnitExternalID', HandlingUnit, '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_HEIGHT

HANDLING_UNIT_HEIGHT: BigNumberField<HandlingUnit> = new BigNumberField('HandlingUnitHeight', HandlingUnit, 'Edm.Decimal')

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

Static HANDLING_UNIT_LENGTH

HANDLING_UNIT_LENGTH: BigNumberField<HandlingUnit> = new BigNumberField('HandlingUnitLength', HandlingUnit, 'Edm.Decimal')

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

Static HANDLING_UNIT_MAX_WEIGHT

HANDLING_UNIT_MAX_WEIGHT: BigNumberField<HandlingUnit> = new BigNumberField('HandlingUnitMaxWeight', HandlingUnit, 'Edm.Decimal')

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

Static HANDLING_UNIT_NET_VOLUME

HANDLING_UNIT_NET_VOLUME: BigNumberField<HandlingUnit> = new BigNumberField('HandlingUnitNetVolume', HandlingUnit, 'Edm.Decimal')

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

Static HANDLING_UNIT_PROCESS_STATUS

HANDLING_UNIT_PROCESS_STATUS: StringField<HandlingUnit> = new StringField('HandlingUnitProcessStatus', HandlingUnit, 'Edm.String')

Static representation of the handlingUnitProcessStatus 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<HandlingUnit> = new StringField('HandlingUnitReferenceDocument', HandlingUnit, '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_TARE_VOLUME

HANDLING_UNIT_TARE_VOLUME: BigNumberField<HandlingUnit> = new BigNumberField('HandlingUnitTareVolume', HandlingUnit, 'Edm.Decimal')

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

Static HANDLING_UNIT_TARE_VOLUME_UNIT

HANDLING_UNIT_TARE_VOLUME_UNIT: StringField<HandlingUnit> = new StringField('HandlingUnitTareVolumeUnit', HandlingUnit, 'Edm.String')

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

Static HANDLING_UNIT_TARE_WEIGHT

HANDLING_UNIT_TARE_WEIGHT: BigNumberField<HandlingUnit> = new BigNumberField('HandlingUnitTareWeight', HandlingUnit, 'Edm.Decimal')

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

Static HANDLING_UNIT_TARE_WEIGHT_UNIT

HANDLING_UNIT_TARE_WEIGHT_UNIT: StringField<HandlingUnit> = new StringField('HandlingUnitTareWeightUnit', HandlingUnit, 'Edm.String')

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

Static HANDLING_UNIT_WIDTH

HANDLING_UNIT_WIDTH: BigNumberField<HandlingUnit> = new BigNumberField('HandlingUnitWidth', HandlingUnit, 'Edm.Decimal')

Static representation of the handlingUnitWidth 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<HandlingUnit> = new StringField('LastChangedByUser', HandlingUnit, '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_TIME

LAST_CHANGE_DATE_TIME: BigNumberField<HandlingUnit> = new BigNumberField('LastChangeDateTime', HandlingUnit, 'Edm.Decimal')

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

Static NET_WEIGHT

NET_WEIGHT: BigNumberField<HandlingUnit> = new BigNumberField('NetWeight', HandlingUnit, 'Edm.Decimal')

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

Static PACKAGING_MATERIAL

PACKAGING_MATERIAL: StringField<HandlingUnit> = new StringField('PackagingMaterial', HandlingUnit, 'Edm.String')

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

Static PACKAGING_MATERIAL_TYPE

PACKAGING_MATERIAL_TYPE: StringField<HandlingUnit> = new StringField('PackagingMaterialType', HandlingUnit, 'Edm.String')

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

Static TO_HANDLING_UNIT_ITEM

TO_HANDLING_UNIT_ITEM: Link<HandlingUnit, HandlingUnitItem> = new Link('to_HandlingUnitItem', HandlingUnit, HandlingUnitItem)

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

Static UNIT_OF_MEASURE_DIMENSION

UNIT_OF_MEASURE_DIMENSION: StringField<HandlingUnit> = new StringField('UnitOfMeasureDimension', HandlingUnit, 'Edm.String')

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

Static VOLUME_UNIT

VOLUME_UNIT: StringField<HandlingUnit> = new StringField('VolumeUnit', HandlingUnit, 'Edm.String')

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

Static WAREHOUSE

WAREHOUSE: StringField<HandlingUnit> = new StringField('Warehouse', HandlingUnit, '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 WEIGHT_UNIT

WEIGHT_UNIT: StringField<HandlingUnit> = new StringField('WeightUnit', HandlingUnit, 'Edm.String')

Static representation of the weightUnit 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<HandlingUnit> | BigNumberField<HandlingUnit> | Link<HandlingUnit, HandlingUnitItem>> = [HandlingUnit.HANDLING_UNIT_EXTERNAL_ID,HandlingUnit.WAREHOUSE,HandlingUnit.PACKAGING_MATERIAL,HandlingUnit.PACKAGING_MATERIAL_TYPE,HandlingUnit.GROSS_WEIGHT,HandlingUnit.NET_WEIGHT,HandlingUnit.HANDLING_UNIT_MAX_WEIGHT,HandlingUnit.WEIGHT_UNIT,HandlingUnit.HANDLING_UNIT_TARE_WEIGHT,HandlingUnit.HANDLING_UNIT_TARE_WEIGHT_UNIT,HandlingUnit.GROSS_VOLUME,HandlingUnit.HANDLING_UNIT_NET_VOLUME,HandlingUnit.VOLUME_UNIT,HandlingUnit.HANDLING_UNIT_TARE_VOLUME,HandlingUnit.HANDLING_UNIT_TARE_VOLUME_UNIT,HandlingUnit.HANDLING_UNIT_LENGTH,HandlingUnit.HANDLING_UNIT_WIDTH,HandlingUnit.HANDLING_UNIT_HEIGHT,HandlingUnit.UNIT_OF_MEASURE_DIMENSION,HandlingUnit.HANDLING_UNIT_REFERENCE_DOCUMENT,HandlingUnit.CREATED_BY_USER,HandlingUnit.CREATION_DATE_TIME,HandlingUnit.LAST_CHANGED_BY_USER,HandlingUnit.LAST_CHANGE_DATE_TIME,HandlingUnit.HANDLING_UNIT_PROCESS_STATUS,HandlingUnit.TO_HANDLING_UNIT_ITEM]

All fields of the HandlingUnit entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "HandlingUnit"

Technical entity name for HandlingUnit.

Static _keyFields

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

All key fields of the HandlingUnit entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "cds_api_handling_unit"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<HandlingUnit>

    A builder that constructs instances of entity type HandlingUnit.

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

    Returns HandlingUnitRequestBuilder

    A HandlingUnit request builder.