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

Class DefaultConsolidationUnitService

java.lang.Object

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

All Implemented Interfaces:

BatchService<ConsolidationUnitServiceBatch>, ConsolidationUnitService

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

A consolidation unit is the smallest entity of the corporate group structure that can be used as the basis for performing a consolidation. Consolidation units belong to the master data of group reporting.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CONSOLIDATIONUNIT
API Version:	1
Communication Scenario:	Finance - Cloud Consolidation Master Data for Group Reporting Integration (SAP_COM_0336), Finance - Cloud Consolidation Data Collection Integration (SAP_COM_0241)
Scope Items:	Group Reporting - Data from External Systems (2U6), Group Reporting - Data from SAP Group Reporting Data Collection (287)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	ConsolidationUnit

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultConsolidationUnitService() Creates a service using ConsolidationUnitService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultConsolidationUnitServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
ConsolidationUnitFluentHelper	getAllConsolidationUnit() Fetch multiple ConsolidationUnit entities.
ConsolidationUnitByTimeFluentHelper	getAllConsolidationUnitByTime() Fetch multiple ConsolidationUnitByTime entities.
ConsolidationUnitByTimeVersionFluentHelper	getAllConsolidationUnitByTimeVersion() Fetch multiple ConsolidationUnitByTimeVersion entities.
ConsolidationUnitTextFluentHelper	getAllConsolidationUnitText() Fetch multiple ConsolidationUnitText entities.
ConsolidationUnitByKeyFluentHelper	getConsolidationUnitByKey(String consolidationUnit) Fetch a single ConsolidationUnit entity using key fields.
ConsolidationUnitByTimeByKeyFluentHelper	getConsolidationUnitByTimeByKey(String consolidationUnit, String fromFiscalYearPeriod) Fetch a single ConsolidationUnitByTime entity using key fields.
ConsolidationUnitByTimeVersionByKeyFluentHelper	getConsolidationUnitByTimeVersionByKey(String consolidationUnit, String consolidationVersion, String fromFiscalYearPeriod) Fetch a single ConsolidationUnitByTimeVersion entity using key fields.
ConsolidationUnitTextByKeyFluentHelper	getConsolidationUnitTextByKey(String language, String consolidationUnit) Fetch a single ConsolidationUnitText entity using key fields.
DefaultConsolidationUnitService	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

DefaultConsolidationUnitService

public DefaultConsolidationUnitService()

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

Method Detail

withServicePath

@Nonnull
public DefaultConsolidationUnitService withServicePath(@Nonnull
                                                                String servicePath)

Description copied from interface: ConsolidationUnitService

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 ConsolidationUnitService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultConsolidationUnitServiceBatch batch()

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

Specified by:

batch in interface BatchService<ConsolidationUnitServiceBatch>

Returns:

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

getAllConsolidationUnitByTime

@Nonnull
public ConsolidationUnitByTimeFluentHelper getAllConsolidationUnitByTime()

Description copied from interface: ConsolidationUnitService

Fetch multiple ConsolidationUnitByTime entities.

Specified by:

getAllConsolidationUnitByTime in interface ConsolidationUnitService

Returns:

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

getConsolidationUnitByTimeByKey

@Nonnull
public ConsolidationUnitByTimeByKeyFluentHelper getConsolidationUnitByTimeByKey(String consolidationUnit,
                                                                                         String fromFiscalYearPeriod)

Description copied from interface: ConsolidationUnitService

Fetch a single ConsolidationUnitByTime entity using key fields.

Specified by:

getConsolidationUnitByTimeByKey in interface ConsolidationUnitService

Parameters:

consolidationUnit - Consolidation Unit

Constraints: Not nullable, Maximum length: 18

fromFiscalYearPeriod - From Fiscal Year Period

Constraints: Not nullable, Maximum length: 7

Returns:

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

getAllConsolidationUnitByTimeVersion

@Nonnull
public ConsolidationUnitByTimeVersionFluentHelper getAllConsolidationUnitByTimeVersion()

Description copied from interface: ConsolidationUnitService

Fetch multiple ConsolidationUnitByTimeVersion entities.

Specified by:

getAllConsolidationUnitByTimeVersion in interface ConsolidationUnitService

Returns:

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

getConsolidationUnitByTimeVersionByKey

@Nonnull
public ConsolidationUnitByTimeVersionByKeyFluentHelper getConsolidationUnitByTimeVersionByKey(String consolidationUnit,
                                                                                                       String consolidationVersion,
                                                                                                       String fromFiscalYearPeriod)

Description copied from interface: ConsolidationUnitService

Fetch a single ConsolidationUnitByTimeVersion entity using key fields.

Specified by:

getConsolidationUnitByTimeVersionByKey in interface ConsolidationUnitService

Parameters:

consolidationUnit - Consolidation Unit

Constraints: Not nullable, Maximum length: 18

consolidationVersion - Enter a Consolidation Version.

Constraints: Not nullable, Maximum length: 3

fromFiscalYearPeriod - From Fiscal Year Period

Constraints: Not nullable, Maximum length: 7

Returns:

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

getAllConsolidationUnitText

@Nonnull
public ConsolidationUnitTextFluentHelper getAllConsolidationUnitText()

Description copied from interface: ConsolidationUnitService

Fetch multiple ConsolidationUnitText entities.

Specified by:

getAllConsolidationUnitText in interface ConsolidationUnitService

Returns:

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

getConsolidationUnitTextByKey

@Nonnull
public ConsolidationUnitTextByKeyFluentHelper getConsolidationUnitTextByKey(String language,
                                                                                     String consolidationUnit)

Description copied from interface: ConsolidationUnitService

Fetch a single ConsolidationUnitText entity using key fields.

Specified by:

getConsolidationUnitTextByKey in interface ConsolidationUnitService

Parameters:

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

consolidationUnit - Consolidation Unit

Constraints: Not nullable, Maximum length: 18

Returns:

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

getAllConsolidationUnit

@Nonnull
public ConsolidationUnitFluentHelper getAllConsolidationUnit()

Description copied from interface: ConsolidationUnitService

Fetch multiple ConsolidationUnit entities.

Specified by:

getAllConsolidationUnit in interface ConsolidationUnitService

Returns:

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

getConsolidationUnitByKey

@Nonnull
public ConsolidationUnitByKeyFluentHelper getConsolidationUnitByKey(String consolidationUnit)

Description copied from interface: ConsolidationUnitService

Fetch a single ConsolidationUnit entity using key fields.

Specified by:

getConsolidationUnitByKey in interface ConsolidationUnitService

Parameters:

consolidationUnit - Consolidation Unit

Constraints: Not nullable, Maximum length: 18

Returns:

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