com.sap.cloud.sdk.s4hana.datamodel.odata.services

Interface DistributionChannelService

All Known Implementing Classes:

DefaultDistributionChannelService

public interface DistributionChannelService

This service enables you to display distribution channel master data to be consumed in SAP Fiori apps and on other user interfaces.

https://help.sap.com/viewer/3f5e57b7dd764ff58bffbed104dbf185/latest/en-US/b240ab069b9542209ffdc3d3585adc9f.html

Reference: SAP API Business Hub

Details:

OData Service:	API_DISTRIBUTIONCHANNEL_SRV
API Version:	1
Communication Scenario:	SAP Analytics Cloud for Planning Integration (SAP_COM_0087)
Scope Items:	Integration between SAP S/4HANA Cloud and SAP Analytics Cloud (1YB)
Authentication Methods:	Basic, x509

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
DistributionChannelFluentHelper	getAllDistributionChannel() Fetch multiple DistributionChannel entities.
DistributionChannelTextFluentHelper	getAllDistributionChannelText() Fetch multiple DistributionChannelText entities.
DistributionChannelByKeyFluentHelper	getDistributionChannelByKey(String distributionChannel) Fetch a single DistributionChannel entity using key fields.
DistributionChannelTextByKeyFluentHelper	getDistributionChannelTextByKey(String distributionChannel, String language) Fetch a single DistributionChannelText entity using key fields.
DistributionChannelService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

DistributionChannelService withServicePath(@Nonnull
                                           String servicePath)

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path

getAllDistributionChannel

@Nonnull
DistributionChannelFluentHelper getAllDistributionChannel()

Fetch multiple DistributionChannel entities.

Returns:

A fluent helper to fetch multiple DistributionChannel entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getDistributionChannelByKey

@Nonnull
DistributionChannelByKeyFluentHelper getDistributionChannelByKey(String distributionChannel)

Fetch a single DistributionChannel entity using key fields.

Parameters:

distributionChannel - Distribution Channel

Constraints: Not nullable, Maximum length: 2

Returns:

A fluent helper to fetch a single DistributionChannel entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getAllDistributionChannelText

@Nonnull
DistributionChannelTextFluentHelper getAllDistributionChannelText()

Fetch multiple DistributionChannelText entities.

Returns:

A fluent helper to fetch multiple DistributionChannelText entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getDistributionChannelTextByKey

@Nonnull
DistributionChannelTextByKeyFluentHelper getDistributionChannelTextByKey(String distributionChannel,
                                                                                  String language)

Fetch a single DistributionChannelText entity using key fields.

Parameters:

language - Language Key

Constraints: Not nullable, Maximum length: 2

distributionChannel - Distribution Channel

Constraints: Not nullable, Maximum length: 2

Returns:

A fluent helper to fetch a single DistributionChannelText entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.