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

Class BillingDocumentTextByKeyFluentHelper

java.lang.Object

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

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperByKey<BillingDocumentTextByKeyFluentHelper,BillingDocumentText,BillingDocumentTextSelectable>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billingdocument.BillingDocumentTextByKeyFluentHelper

All Implemented Interfaces:

FluentHelperCustomHttpHeader<BillingDocumentTextByKeyFluentHelper>, FluentHelperExecutable<Object>

public class BillingDocumentTextByKeyFluentHelper
extends FluentHelperByKey<BillingDocumentTextByKeyFluentHelper,BillingDocumentText,BillingDocumentTextSelectable>

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

Method Summary

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

BillingDocumentTextByKeyFluentHelper

@Deprecated
public BillingDocumentTextByKeyFluentHelper(@Nonnull
                                                        String servicePath,
                                                        String billingDocument,
                                                        String language,
                                                        String longTextID)

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

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

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

billingDocument - Data Element for Billing

Constraints: Not nullable, Maximum length: 10

longTextID - The text ID defines the various types of texts related to a text object. For example, the object "TEXT" (standard texts) can have the following text IDs:

Constraints: Not nullable, Maximum length: 4

BillingDocumentTextByKeyFluentHelper

public BillingDocumentTextByKeyFluentHelper(@Nonnull
                                            String servicePath,
                                            @Nonnull
                                            String entityCollection,
                                            String billingDocument,
                                            String language,
                                            String longTextID)

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

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

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

billingDocument - Data Element for Billing

Constraints: Not nullable, Maximum length: 10

longTextID - The text ID defines the various types of texts related to a text object. For example, the object "TEXT" (standard texts) can have the following text IDs:

Constraints: Not nullable, Maximum length: 4

Method Detail

getEntityClass

@Nonnull
protected Class<BillingDocumentText> getEntityClass()

Description copied from class: FluentHelperBasic

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

Specified by:

getEntityClass in class FluentHelperBasic<BillingDocumentTextByKeyFluentHelper,BillingDocumentText,BillingDocumentText>

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<BillingDocumentTextByKeyFluentHelper,BillingDocumentText,BillingDocumentTextSelectable>

Returns:

A name-value mapping for the OData key properties.