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

Interface CustomerGroupService

All Superinterfaces:

BatchService<CustomerGroupServiceBatch>

All Known Implementing Classes:

DefaultCustomerGroupService

public interface CustomerGroupService
extends BatchService<CustomerGroupServiceBatch>

This service enables you to read customer group master data in an API call. It is based on the OData protocol, and can be consumed in Fiori apps and on other user interfaces.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CUSTOMERGROUP_SRV
API Version:	1
Communication Scenario:	SAP Business Objects Cloud for Planning Integration (SAP_COM_0087)
Scope Items:	oData Integration with SAP Business Objects Cloud for Planning (1YB)

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
CustomerGroupFluentHelper	getAllCustomerGroup() Fetch multiple CustomerGroup entities.
CustomerGroupTextFluentHelper	getAllCustomerGroupText() Fetch multiple CustomerGroupText entities.
CustomerGroupByKeyFluentHelper	getCustomerGroupByKey(String customerGroup) Fetch a single CustomerGroup entity using key fields.
CustomerGroupTextByKeyFluentHelper	getCustomerGroupTextByKey(String customerGroup, String language) Fetch a single CustomerGroupText entity using key fields.
CustomerGroupService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService

batch

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

@Nonnull
CustomerGroupService 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.

getAllCustomerGroup

@Nonnull
CustomerGroupFluentHelper getAllCustomerGroup()

Fetch multiple CustomerGroup entities.

Returns:

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

getCustomerGroupByKey

@Nonnull
CustomerGroupByKeyFluentHelper getCustomerGroupByKey(String customerGroup)

Fetch a single CustomerGroup entity using key fields.

Parameters:

customerGroup - Identifies a particular group of customers (for example, wholesale or retail) for the purpose of pricing or generating statistics.

Constraints: Not nullable, Maximum length: 2

Returns:

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

getAllCustomerGroupText

@Nonnull
CustomerGroupTextFluentHelper getAllCustomerGroupText()

Fetch multiple CustomerGroupText entities.

Returns:

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

getCustomerGroupTextByKey

@Nonnull
CustomerGroupTextByKeyFluentHelper getCustomerGroupTextByKey(String customerGroup,
                                                                      String language)

Fetch a single CustomerGroupText entity using key fields.

Parameters:

customerGroup - Identifies a particular group of customers (for example, wholesale or retail) for the purpose of pricing or generating statistics.

Constraints: Not nullable, Maximum length: 2

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

Returns:

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