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

Class ValueByKeyFluentHelper

java.lang.Object

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

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperByKey<ValueByKeyFluentHelper,Value,ValueSelectable>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.functionallocation.ValueByKeyFluentHelper

All Implemented Interfaces:

FluentHelperCustomHttpHeader<ValueByKeyFluentHelper>, FluentHelperExecutable<Object>

public class ValueByKeyFluentHelper
extends FluentHelperByKey<ValueByKeyFluentHelper,Value,ValueSelectable>

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

Method Summary

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

ValueByKeyFluentHelper

@Deprecated
public ValueByKeyFluentHelper(@Nonnull
                                          String servicePath,
                                          String functionalLocation,
                                          String classType,
                                          String charcValuePositionNumber,
                                          String charcInternalID)

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

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

Parameters:

charcValuePositionNumber - Characteristic value counter

Constraints: Not nullable, Maximum length: 3

charcInternalID - Characteristic Internal ID

Constraints: Not nullable, Maximum length: 10

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

functionalLocation - Key of Object to be Classified

Constraints: Not nullable, Maximum length: 90

classType - Uniquely identifies the class type

Constraints: Not nullable, Maximum length: 3

ValueByKeyFluentHelper

public ValueByKeyFluentHelper(@Nonnull
                              String servicePath,
                              @Nonnull
                              String entityCollection,
                              String functionalLocation,
                              String classType,
                              String charcValuePositionNumber,
                              String charcInternalID)

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

charcValuePositionNumber - Characteristic value counter

Constraints: Not nullable, Maximum length: 3

charcInternalID - Characteristic Internal ID

Constraints: Not nullable, Maximum length: 10

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

functionalLocation - Key of Object to be Classified

Constraints: Not nullable, Maximum length: 90

classType - Uniquely identifies the class type

Constraints: Not nullable, Maximum length: 3

Method Detail

getEntityClass

@Nonnull
protected Class<Value> getEntityClass()

Description copied from class: FluentHelperBasic

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

Specified by:

getEntityClass in class FluentHelperBasic<ValueByKeyFluentHelper,Value,Value>

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<ValueByKeyFluentHelper,Value,ValueSelectable>

Returns:

A name-value mapping for the OData key properties.