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

Class MaterialDocumentHeaderByKeyFluentHelper

java.lang.Object

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

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperByKey<MaterialDocumentHeaderByKeyFluentHelper,MaterialDocumentHeader,MaterialDocumentHeaderSelectable>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialdocument.MaterialDocumentHeaderByKeyFluentHelper

public class MaterialDocumentHeaderByKeyFluentHelper
extends FluentHelperByKey<MaterialDocumentHeaderByKeyFluentHelper,MaterialDocumentHeader,MaterialDocumentHeaderSelectable>

Fluent helper to fetch a single MaterialDocumentHeader 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
MaterialDocumentHeaderByKeyFluentHelper(String servicePath, String materialDocumentYear, String materialDocument) Creates a fluent helper object that will fetch a single MaterialDocumentHeader entity with the provided key field values.

Method Summary

Modifier and Type	Method and Description
protected Class<MaterialDocumentHeader>	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, getQueryBuilder, select, toQuery, withErrorHandler, withQueryParameter

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

cachingMetadata, getHeadersForRequestAndImplicitRequests, getHeadersForRequestOnly, getParametersForRequestOnly, getServicePath, getThis, getVersionIdentifier, isCachingMetadata, withHeader, withHeaders, withoutCachingMetadata

Methods inherited from class java.lang.Object

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

Constructor Detail

MaterialDocumentHeaderByKeyFluentHelper

public MaterialDocumentHeaderByKeyFluentHelper(@Nonnull
                                               String servicePath,
                                               String materialDocumentYear,
                                               String materialDocument)

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

Parameters:

materialDocument - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

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

materialDocumentYear - Material Document Year

Constraints: Not nullable, Maximum length: 4

Method Detail

getEntityClass

@Nonnull
protected Class<MaterialDocumentHeader> getEntityClass()

Description copied from class: FluentHelperBasic

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

Specified by:

getEntityClass in class FluentHelperBasic<MaterialDocumentHeaderByKeyFluentHelper,MaterialDocumentHeader,MaterialDocumentHeader>

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<MaterialDocumentHeaderByKeyFluentHelper,MaterialDocumentHeader,MaterialDocumentHeaderSelectable>

Returns:

A name-value mapping for the OData key properties.