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

Class DefaultSalesDistrictService

java.lang.Object

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

All Implemented Interfaces:

BatchService<SalesDistrictServiceBatch>, SalesDistrictService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultSalesDistrictService")
public class DefaultSalesDistrictService
extends Object
implements SalesDistrictService

The service contains sales district and sales district text nodes.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_SALESDISTRICT_SRV
API Version:	1
Communication Scenario:	SAP Analytics Cloud for Planning Integration (SAP_COM_0087)
Scope Items:	Import Connection setup with SAP Analytics Cloud (1YB)
Authentication Methods:	Basic, x509

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.SalesDistrictService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultSalesDistrictService() Creates a service using SalesDistrictService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultSalesDistrictServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
SalesDistrictFluentHelper	getAllSalesDistrict() Fetch multiple SalesDistrict entities.
SalesDistrictTextFluentHelper	getAllSalesDistrictText() Fetch multiple SalesDistrictText entities.
SalesDistrictByKeyFluentHelper	getSalesDistrictByKey(String salesDistrict) Fetch a single SalesDistrict entity using key fields.
SalesDistrictTextByKeyFluentHelper	getSalesDistrictTextByKey(String salesDistrict, String language) Fetch a single SalesDistrictText entity using key fields.
DefaultSalesDistrictService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultSalesDistrictService

public DefaultSalesDistrictService()

Creates a service using SalesDistrictService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultSalesDistrictService withServicePath(@Nonnull
                                                            String servicePath)

Description copied from interface: SalesDistrictService

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

Specified by:

withServicePath in interface SalesDistrictService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultSalesDistrictServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<SalesDistrictServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllSalesDistrict

@Nonnull
public SalesDistrictFluentHelper getAllSalesDistrict()

Description copied from interface: SalesDistrictService

Fetch multiple SalesDistrict entities.

Specified by:

getAllSalesDistrict in interface SalesDistrictService

Returns:

A fluent helper to fetch multiple SalesDistrict 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.

getSalesDistrictByKey

@Nonnull
public SalesDistrictByKeyFluentHelper getSalesDistrictByKey(String salesDistrict)

Description copied from interface: SalesDistrictService

Fetch a single SalesDistrict entity using key fields.

Specified by:

getSalesDistrictByKey in interface SalesDistrictService

Parameters:

salesDistrict - A geographical sales district or region.

Constraints: Not nullable, Maximum length: 6

Returns:

A fluent helper to fetch a single SalesDistrict 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.

getAllSalesDistrictText

@Nonnull
public SalesDistrictTextFluentHelper getAllSalesDistrictText()

Description copied from interface: SalesDistrictService

Fetch multiple SalesDistrictText entities.

Specified by:

getAllSalesDistrictText in interface SalesDistrictService

Returns:

A fluent helper to fetch multiple SalesDistrictText 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.

getSalesDistrictTextByKey

@Nonnull
public SalesDistrictTextByKeyFluentHelper getSalesDistrictTextByKey(String salesDistrict,
                                                                             String language)

Description copied from interface: SalesDistrictService

Fetch a single SalesDistrictText entity using key fields.

Specified by:

getSalesDistrictTextByKey in interface SalesDistrictService

Parameters:

salesDistrict - A geographical sales district or region.

Constraints: Not nullable, Maximum length: 6

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

Returns:

A fluent helper to fetch a single SalesDistrictText 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.