com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.handlingunit

Class HandlingUnitByKeyFluentHelper

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperBasic<FluentHelperT,EntityT,EntityT>

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperByKey<HandlingUnitByKeyFluentHelper,HandlingUnit,HandlingUnitSelectable>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.handlingunit.HandlingUnitByKeyFluentHelper

All Implemented Interfaces:

FluentHelperCustomHttpHeader<HandlingUnitByKeyFluentHelper>, FluentHelperExecutable<Object>

public class HandlingUnitByKeyFluentHelper
extends FluentHelperByKey<HandlingUnitByKeyFluentHelper,HandlingUnit,HandlingUnitSelectable>

Fluent helper to fetch a single HandlingUnit entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself.

Constructor Summary

Constructors

Constructor and Description
HandlingUnitByKeyFluentHelper(String servicePath, String handlingUnitExternalID, String warehouse) Deprecated. Use the constructor HandlingUnitByKeyFluentHelper(String, String, String, String) instead.
HandlingUnitByKeyFluentHelper(String servicePath, String entityCollection, String handlingUnitExternalID, String warehouse) Creates a fluent helper object that will fetch a single HandlingUnit entity with the provided key field values.

Method Summary

Modifier and Type	Method and Description
protected Class<HandlingUnit>	getEntityClass() Returns a class object of the type this fluent helper works with.
protected Map<String,Object>	getKey() Getter for a map containing the OData name of key properties, each mapped to the value to search by.

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperByKey

execute, executeRequest, getQueryBuilder, select, toQuery, toRequest, withErrorHandler, withQueryParameter

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperBasic

and, cachingMetadata, getHeaders, getHeadersForRequestAndImplicitRequests, getHeadersForRequestOnly, getParametersForRequestOnly, getServicePath, getThis, getVersionIdentifier, isCachingMetadata, onRequestAndImplicitRequests, onRequestOnly, withHeader, withHeaders, withoutCachingMetadata

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HandlingUnitByKeyFluentHelper

@Deprecated
public HandlingUnitByKeyFluentHelper(@Nonnull
                                                 String servicePath,
                                                 String handlingUnitExternalID,
                                                 String warehouse)

Deprecated. Use the constructor HandlingUnitByKeyFluentHelper(String, String, String, String) instead.

Creates a fluent helper object that will fetch a single HandlingUnit entity with the provided key field values. To perform execution, call the execute method on the fluent helper object.

Parameters:

handlingUnitExternalID - Specifies an external identifier for the handling unit.

Constraints: Not nullable, Maximum length: 20

servicePath - Service path to be used to fetch a single HandlingUnit

warehouse - Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system.

Constraints: Not nullable, Maximum length: 4

HandlingUnitByKeyFluentHelper

public HandlingUnitByKeyFluentHelper(@Nonnull
                                     String servicePath,
                                     @Nonnull
                                     String entityCollection,
                                     String handlingUnitExternalID,
                                     String warehouse)

Creates a fluent helper object that will fetch a single HandlingUnit entity with the provided key field values. To perform execution, call the execute method on the fluent helper object.

Parameters:

entityCollection - Entity Collection to be used to fetch a single HandlingUnit

handlingUnitExternalID - Specifies an external identifier for the handling unit.

Constraints: Not nullable, Maximum length: 20

servicePath - Service path to be used to fetch a single HandlingUnit

warehouse - Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system.

Constraints: Not nullable, Maximum length: 4

Method Detail

getEntityClass

@Nonnull
protected Class<HandlingUnit> getEntityClass()

Description copied from class: FluentHelperBasic

Returns a class object of the type this fluent helper works with.

Specified by:

getEntityClass in class FluentHelperBasic<HandlingUnitByKeyFluentHelper,HandlingUnit,HandlingUnit>

Returns:

A class object of the handled type.

getKey

@Nonnull
protected Map<String,Object> getKey()

Description copied from class: FluentHelperByKey

Getter for a map containing the OData name of key properties, each mapped to the value to search by.

Specified by:

getKey in class FluentHelperByKey<HandlingUnitByKeyFluentHelper,HandlingUnit,HandlingUnitSelectable>

Returns:

A name-value mapping for the OData key properties.