Package com.sap.cloud.sdk.s4hana.datamodel.odatav4.services

Class DefaultStatutoryReportingReportDefinitionService

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.DefaultStatutoryReportingReportDefinitionService

All Implemented Interfaces:

OperationsOnEntityCollections, ServiceWithNavigableEntities, StatutoryReportingReportDefinitionService

@Named("com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.DefaultStatutoryReportingReportDefinitionService")
public class DefaultStatutoryReportingReportDefinitionService
extends Object
implements ServiceWithNavigableEntities, StatutoryReportingReportDefinitionService

The service contains entities that represent the actions you can complete with this API. Each entity contained in this service is named after an action of Document and Reporting Compliance Report Definition. - Report Definition – Read reports for specified report definition. - Report Parameter Definition – Read phases for the specified report definition. - Document Definition – Read activities for the specified report definition. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	CE_STATRYRPTRPTDEFINITION_0001
API Version:	1.0.0
Minimum ERP Version:	2302
Communication Scenario:	Finance - ACR Services for Partner Enablement Integration(SAP_COM_0775)
Scope Items:	Compliance Formats - Support Preparation(1J2)
Authentication Methods:	x509
Service Group Name:	API_STATRYRPTRPTDEFINITION
Business Object:	Statutory Reporting Report Definition

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.StatutoryReportingReportDefinitionService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor	Description
DefaultStatutoryReportingReportDefinitionService()	Creates a service using StatutoryReportingReportDefinitionService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method	Description
BatchRequestBuilder	batch()	Creates a batch request builder object.
CountRequestBuilder<DocumentDef>	countDocumentDef()	Fetch the number of entries from the DocumentDef entity collection matching the filter and search expressions.
CountRequestBuilder<ReportDef>	countReportDef()	Fetch the number of entries from the ReportDef entity collection matching the filter and search expressions.
CountRequestBuilder<ReportParameterDef>	countReportParameterDef()	Fetch the number of entries from the ReportParameterDef entity collection matching the filter and search expressions.
GetAllRequestBuilder<DocumentDef>	getAllDocumentDef()	Fetch multiple DocumentDef entities.
GetAllRequestBuilder<ReportDef>	getAllReportDef()	Fetch multiple ReportDef entities.
GetAllRequestBuilder<ReportParameterDef>	getAllReportParameterDef()	Fetch multiple ReportParameterDef entities.
GetByKeyRequestBuilder<DocumentDef>	getDocumentDefByKey(String statryRptDef, String statryRptDocumentID)	Fetch a single DocumentDef entity using key fields.
GetByKeyRequestBuilder<ReportDef>	getReportDefByKey(String statryRptDef)	Fetch a single ReportDef entity using key fields.
GetByKeyRequestBuilder<ReportParameterDef>	getReportParameterDefByKey(String statryRptDef, String statryRptParameterID)	Fetch a single ReportParameterDef entity using key fields.
String	getServicePath()
DefaultStatutoryReportingReportDefinitionService	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

Methods inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.ServiceWithNavigableEntities

applyAction, applyAction, applyFunction, applyFunction, forEntity, withFunction, withFunction

Constructor Details

DefaultStatutoryReportingReportDefinitionService

public DefaultStatutoryReportingReportDefinitionService()

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

Method Details

withServicePath

@Nonnull
public DefaultStatutoryReportingReportDefinitionService withServicePath(@Nonnull
 String servicePath)

Description copied from interface: StatutoryReportingReportDefinitionService

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 StatutoryReportingReportDefinitionService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public BatchRequestBuilder batch()

Description copied from interface: StatutoryReportingReportDefinitionService

Creates a batch request builder object.

Specified by:

batch in interface StatutoryReportingReportDefinitionService

Returns:

A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.

getAllDocumentDef

@Nonnull
public GetAllRequestBuilder<DocumentDef> getAllDocumentDef()

Description copied from interface: StatutoryReportingReportDefinitionService

Fetch multiple DocumentDef entities.

Specified by:

getAllDocumentDef in interface StatutoryReportingReportDefinitionService

Returns:

A request builder to fetch multiple DocumentDef entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countDocumentDef

@Nonnull
public CountRequestBuilder<DocumentDef> countDocumentDef()

Description copied from interface: StatutoryReportingReportDefinitionService

Fetch the number of entries from the DocumentDef entity collection matching the filter and search expressions.

Specified by:

countDocumentDef in interface StatutoryReportingReportDefinitionService

Returns:

A request builder to fetch the count of DocumentDef entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getDocumentDefByKey

@Nonnull
public GetByKeyRequestBuilder<DocumentDef> getDocumentDefByKey(String statryRptDef,
 String statryRptDocumentID)

Description copied from interface: StatutoryReportingReportDefinitionService

Fetch a single DocumentDef entity using key fields.

Specified by:

getDocumentDefByKey in interface StatutoryReportingReportDefinitionService

Parameters:

statryRptDef - Report Definition

Constraints: Not nullable, Maximum length: 30

statryRptDocumentID - Document ID

Constraints: Not nullable, Maximum length: 30

Returns:

A request builder to fetch a single DocumentDef entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getAllReportDef

@Nonnull
public GetAllRequestBuilder<ReportDef> getAllReportDef()

Description copied from interface: StatutoryReportingReportDefinitionService

Fetch multiple ReportDef entities.

Specified by:

getAllReportDef in interface StatutoryReportingReportDefinitionService

Returns:

A request builder to fetch multiple ReportDef entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countReportDef

@Nonnull
public CountRequestBuilder<ReportDef> countReportDef()

Description copied from interface: StatutoryReportingReportDefinitionService

Fetch the number of entries from the ReportDef entity collection matching the filter and search expressions.

Specified by:

countReportDef in interface StatutoryReportingReportDefinitionService

Returns:

A request builder to fetch the count of ReportDef entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getReportDefByKey

@Nonnull
public GetByKeyRequestBuilder<ReportDef> getReportDefByKey(String statryRptDef)

Description copied from interface: StatutoryReportingReportDefinitionService

Fetch a single ReportDef entity using key fields.

Specified by:

getReportDefByKey in interface StatutoryReportingReportDefinitionService

Parameters:

statryRptDef - Report Definition

Constraints: Not nullable, Maximum length: 30

Returns:

A request builder to fetch a single ReportDef entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getAllReportParameterDef

@Nonnull
public GetAllRequestBuilder<ReportParameterDef> getAllReportParameterDef()

Description copied from interface: StatutoryReportingReportDefinitionService

Fetch multiple ReportParameterDef entities.

Specified by:

getAllReportParameterDef in interface StatutoryReportingReportDefinitionService

Returns:

A request builder to fetch multiple ReportParameterDef entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countReportParameterDef

@Nonnull
public CountRequestBuilder<ReportParameterDef> countReportParameterDef()

Description copied from interface: StatutoryReportingReportDefinitionService

Fetch the number of entries from the ReportParameterDef entity collection matching the filter and search expressions.

Specified by:

countReportParameterDef in interface StatutoryReportingReportDefinitionService

Returns:

A request builder to fetch the count of ReportParameterDef entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getReportParameterDefByKey

@Nonnull
public GetByKeyRequestBuilder<ReportParameterDef> getReportParameterDefByKey(String statryRptDef,
 String statryRptParameterID)

Description copied from interface: StatutoryReportingReportDefinitionService

Fetch a single ReportParameterDef entity using key fields.

Specified by:

getReportParameterDefByKey in interface StatutoryReportingReportDefinitionService

Parameters:

statryRptDef - Report Definition

Constraints: Not nullable, Maximum length: 30

statryRptParameterID - Report parameter identificator

Constraints: Not nullable, Maximum length: 30

Returns:

A request builder to fetch a single ReportParameterDef entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getServicePath

@Nonnull
public String getServicePath()

Specified by:

getServicePath in interface ServiceWithNavigableEntities