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

Class ReferenceDocumentByKeyFluentHelper

java.lang.Object

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

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperByKey<ReferenceDocumentByKeyFluentHelper,ReferenceDocument,ReferenceDocumentSelectable>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.trialbalance.ReferenceDocumentByKeyFluentHelper

All Implemented Interfaces:

FluentHelperCustomHttpHeader<ReferenceDocumentByKeyFluentHelper>, FluentHelperExecutable<Object>

public class ReferenceDocumentByKeyFluentHelper
extends FluentHelperByKey<ReferenceDocumentByKeyFluentHelper,ReferenceDocument,ReferenceDocumentSelectable>

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

Method Summary

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

ReferenceDocumentByKeyFluentHelper

@Deprecated
public ReferenceDocumentByKeyFluentHelper(@Nonnull
                                                      String servicePath,
                                                      String referenceDocumentType_ID)

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

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

Parameters:

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

referenceDocumentType_ID - Ref. Document Type

Constraints: Not nullable, Maximum length: 5

ReferenceDocumentByKeyFluentHelper

public ReferenceDocumentByKeyFluentHelper(@Nonnull
                                          String servicePath,
                                          @Nonnull
                                          String entityCollection,
                                          String referenceDocumentType_ID)

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

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

referenceDocumentType_ID - Ref. Document Type

Constraints: Not nullable, Maximum length: 5

Method Detail

getEntityClass

@Nonnull
protected Class<ReferenceDocument> getEntityClass()

Description copied from class: FluentHelperBasic

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

Specified by:

getEntityClass in class FluentHelperBasic<ReferenceDocumentByKeyFluentHelper,ReferenceDocument,ReferenceDocument>

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<ReferenceDocumentByKeyFluentHelper,ReferenceDocument,ReferenceDocumentSelectable>

Returns:

A name-value mapping for the OData key properties.