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

Class DefaultCustomerGroupService

java.lang.Object

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

All Implemented Interfaces:

BatchService<CustomerGroupServiceBatch>, CustomerGroupService

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

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 inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.CustomerGroupService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultCustomerGroupService() Creates a service using CustomerGroupService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultCustomerGroupServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
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.
DefaultCustomerGroupService	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

DefaultCustomerGroupService

public DefaultCustomerGroupService()

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

Method Detail

withServicePath

@Nonnull
public DefaultCustomerGroupService withServicePath(@Nonnull
                                                            String servicePath)

Description copied from interface: CustomerGroupService

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 CustomerGroupService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultCustomerGroupServiceBatch batch()

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

Specified by:

batch in interface BatchService<CustomerGroupServiceBatch>

Returns:

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

getAllCustomerGroup

@Nonnull
public CustomerGroupFluentHelper getAllCustomerGroup()

Description copied from interface: CustomerGroupService

Fetch multiple CustomerGroup entities.

Specified by:

getAllCustomerGroup in interface CustomerGroupService

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
public CustomerGroupByKeyFluentHelper getCustomerGroupByKey(String customerGroup)

Description copied from interface: CustomerGroupService

Fetch a single CustomerGroup entity using key fields.

Specified by:

getCustomerGroupByKey in interface CustomerGroupService

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
public CustomerGroupTextFluentHelper getAllCustomerGroupText()

Description copied from interface: CustomerGroupService

Fetch multiple CustomerGroupText entities.

Specified by:

getAllCustomerGroupText in interface CustomerGroupService

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
public CustomerGroupTextByKeyFluentHelper getCustomerGroupTextByKey(String customerGroup,
                                                                             String language)

Description copied from interface: CustomerGroupService

Fetch a single CustomerGroupText entity using key fields.

Specified by:

getCustomerGroupTextByKey in interface CustomerGroupService

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.