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

Class DefaultLedgerService

java.lang.Object

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

All Implemented Interfaces:

BatchService<LedgerServiceBatch>, LedgerService

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

The service enables you to retrieve ledgers, their properties like leading ledger and their names in the respective language..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_LEDGER_SRV
API Version:	1
Communication Scenario:	SAP Analytics Cloud for Planning Integration (SAP_COM_0087), Finance - Cloud Consolidation Data Collection Integration (SAP_COM_0241)
Scope Items:	Import Connection setup with SAP Analytics Cloud (1YB), Group Reporting - Data from SAP Group Reporting Data Collection (287)
Authentication Methods:	Basic, x509, OAuth2

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultLedgerService() Creates a service using LedgerService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultLedgerServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
LedgerFluentHelper	getAllLedger() Fetch multiple Ledger entities.
LedgerTextFluentHelper	getAllLedgerText() Fetch multiple LedgerText entities.
LedgerByKeyFluentHelper	getLedgerByKey(String ledger) Fetch a single Ledger entity using key fields.
LedgerTextByKeyFluentHelper	getLedgerTextByKey(String ledger, String language) Fetch a single LedgerText entity using key fields.
DefaultLedgerService	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

DefaultLedgerService

public DefaultLedgerService()

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

Method Detail

withServicePath

@Nonnull
public DefaultLedgerService withServicePath(@Nonnull
                                                     String servicePath)

Description copied from interface: LedgerService

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 LedgerService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultLedgerServiceBatch batch()

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

Specified by:

batch in interface BatchService<LedgerServiceBatch>

Returns:

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

getAllLedger

@Nonnull
public LedgerFluentHelper getAllLedger()

Description copied from interface: LedgerService

Fetch multiple Ledger entities.

Specified by:

getAllLedger in interface LedgerService

Returns:

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

getLedgerByKey

@Nonnull
public LedgerByKeyFluentHelper getLedgerByKey(String ledger)

Description copied from interface: LedgerService

Fetch a single Ledger entity using key fields.

Specified by:

getLedgerByKey in interface LedgerService

Parameters:

ledger - Identifies a ledger in General Ledger Accounting.

Constraints: Not nullable, Maximum length: 2

Returns:

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

getAllLedgerText

@Nonnull
public LedgerTextFluentHelper getAllLedgerText()

Description copied from interface: LedgerService

Fetch multiple LedgerText entities.

Specified by:

getAllLedgerText in interface LedgerService

Returns:

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

getLedgerTextByKey

@Nonnull
public LedgerTextByKeyFluentHelper getLedgerTextByKey(String ledger,
                                                               String language)

Description copied from interface: LedgerService

Fetch a single LedgerText entity using key fields.

Specified by:

getLedgerTextByKey in interface LedgerService

Parameters:

ledger - Identifies a ledger in General Ledger Accounting.

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 LedgerText 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.