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

Class SegmentByKeyFluentHelper

java.lang.Object

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

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperByKey<SegmentByKeyFluentHelper,Segment,SegmentSelectable>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.segment.SegmentByKeyFluentHelper

public class SegmentByKeyFluentHelper
extends FluentHelperByKey<SegmentByKeyFluentHelper,Segment,SegmentSelectable>

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

Method Summary

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

SegmentByKeyFluentHelper

public SegmentByKeyFluentHelper(@Nonnull
                                String servicePath,
                                String segment)

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

segment - Segment for Segmental Reporting

Constraints: Not nullable, Maximum length: 10

Method Detail

getEntityClass

@Nonnull
protected Class<Segment> getEntityClass()

Description copied from class: FluentHelperBasic

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

Specified by:

getEntityClass in class FluentHelperBasic<SegmentByKeyFluentHelper,Segment,Segment>

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<SegmentByKeyFluentHelper,Segment,SegmentSelectable>

Returns:

A name-value mapping for the OData key properties.