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

Class OutbDeliveryHeaderByKeyFluentHelper

java.lang.Object

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

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperByKey<OutbDeliveryHeaderByKeyFluentHelper,OutbDeliveryHeader,OutbDeliveryHeaderSelectable>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.outbounddelivery.OutbDeliveryHeaderByKeyFluentHelper

All Implemented Interfaces:

FluentHelperCustomHttpHeader<OutbDeliveryHeaderByKeyFluentHelper>, FluentHelperExecutable<Object>

public class OutbDeliveryHeaderByKeyFluentHelper
extends FluentHelperByKey<OutbDeliveryHeaderByKeyFluentHelper,OutbDeliveryHeader,OutbDeliveryHeaderSelectable>

Fluent helper to fetch a single OutbDeliveryHeader 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
OutbDeliveryHeaderByKeyFluentHelper(String servicePath, String deliveryDocument) Deprecated. Use the constructor OutbDeliveryHeaderByKeyFluentHelper(String, String, String) instead.
OutbDeliveryHeaderByKeyFluentHelper(String servicePath, String entityCollection, String deliveryDocument) Creates a fluent helper object that will fetch a single OutbDeliveryHeader entity with the provided key field values.

Method Summary

Modifier and Type	Method and Description
protected Class<OutbDeliveryHeader>	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

OutbDeliveryHeaderByKeyFluentHelper

@Deprecated
public OutbDeliveryHeaderByKeyFluentHelper(@Nonnull
                                                       String servicePath,
                                                       String deliveryDocument)

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

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

Parameters:

deliveryDocument - The number that uniquely identifies the delivery.

Constraints: Not nullable, Maximum length: 10

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

OutbDeliveryHeaderByKeyFluentHelper

public OutbDeliveryHeaderByKeyFluentHelper(@Nonnull
                                           String servicePath,
                                           @Nonnull
                                           String entityCollection,
                                           String deliveryDocument)

Creates a fluent helper object that will fetch a single OutbDeliveryHeader 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 OutbDeliveryHeader

deliveryDocument - The number that uniquely identifies the delivery.

Constraints: Not nullable, Maximum length: 10

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

Method Detail

getEntityClass

@Nonnull
protected Class<OutbDeliveryHeader> getEntityClass()

Description copied from class: FluentHelperBasic

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

Specified by:

getEntityClass in class FluentHelperBasic<OutbDeliveryHeaderByKeyFluentHelper,OutbDeliveryHeader,OutbDeliveryHeader>

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<OutbDeliveryHeaderByKeyFluentHelper,OutbDeliveryHeader,OutbDeliveryHeaderSelectable>

Returns:

A name-value mapping for the OData key properties.