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

Class DefaultStatutoryReportingCategoryDefinitionService

java.lang.Object

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

All Implemented Interfaces:

OperationsOnEntityCollections, ServiceWithNavigableEntities, StatutoryReportingCategoryDefinitionService

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

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 Category Definition. - Category Definition – Read categories for specified report category definition. - Phase Definition – Read phases for the specified report category definition. - Activity Definition – Read activities for the specified report category definition. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	CE_STATRYRPTCATDEFINITION_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_STATRYRPTCATDEFINITION
Business Object:	Statutory Reporting Category Definition

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor	Description
DefaultStatutoryReportingCategoryDefinitionService()	Creates a service using StatutoryReportingCategoryDefinitionService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method	Description
BatchRequestBuilder	batch()	Creates a batch request builder object.
CountRequestBuilder<ActivityDef>	countActivityDef()	Fetch the number of entries from the ActivityDef entity collection matching the filter and search expressions.
CountRequestBuilder<CategoryDef>	countCategoryDef()	Fetch the number of entries from the CategoryDef entity collection matching the filter and search expressions.
CountRequestBuilder<PhaseDef>	countPhaseDef()	Fetch the number of entries from the PhaseDef entity collection matching the filter and search expressions.
GetByKeyRequestBuilder<ActivityDef>	getActivityDefByKey(String statryRptCategory, String statryRptActivityId)	Fetch a single ActivityDef entity using key fields.
GetAllRequestBuilder<ActivityDef>	getAllActivityDef()	Fetch multiple ActivityDef entities.
GetAllRequestBuilder<CategoryDef>	getAllCategoryDef()	Fetch multiple CategoryDef entities.
GetAllRequestBuilder<PhaseDef>	getAllPhaseDef()	Fetch multiple PhaseDef entities.
GetByKeyRequestBuilder<CategoryDef>	getCategoryDefByKey(String statryRptCategory)	Fetch a single CategoryDef entity using key fields.
GetByKeyRequestBuilder<PhaseDef>	getPhaseDefByKey(String statryRptCategory, String statryRptCatPhase, LocalDate statryRptCatPhaseValidFromDate)	Fetch a single PhaseDef entity using key fields.
String	getServicePath()
DefaultStatutoryReportingCategoryDefinitionService	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

DefaultStatutoryReportingCategoryDefinitionService

public DefaultStatutoryReportingCategoryDefinitionService()

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

Method Details

withServicePath

@Nonnull
public DefaultStatutoryReportingCategoryDefinitionService withServicePath(@Nonnull
 String servicePath)

Description copied from interface: StatutoryReportingCategoryDefinitionService

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 StatutoryReportingCategoryDefinitionService

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: StatutoryReportingCategoryDefinitionService

Creates a batch request builder object.

Specified by:

batch in interface StatutoryReportingCategoryDefinitionService

Returns:

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

getAllActivityDef

@Nonnull
public GetAllRequestBuilder<ActivityDef> getAllActivityDef()

Description copied from interface: StatutoryReportingCategoryDefinitionService

Fetch multiple ActivityDef entities.

Specified by:

getAllActivityDef in interface StatutoryReportingCategoryDefinitionService

Returns:

A request builder to fetch multiple ActivityDef 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.

countActivityDef

@Nonnull
public CountRequestBuilder<ActivityDef> countActivityDef()

Description copied from interface: StatutoryReportingCategoryDefinitionService

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

Specified by:

countActivityDef in interface StatutoryReportingCategoryDefinitionService

Returns:

A request builder to fetch the count of ActivityDef 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.

getActivityDefByKey

@Nonnull
public GetByKeyRequestBuilder<ActivityDef> getActivityDefByKey(String statryRptCategory,
 String statryRptActivityId)

Description copied from interface: StatutoryReportingCategoryDefinitionService

Fetch a single ActivityDef entity using key fields.

Specified by:

getActivityDefByKey in interface StatutoryReportingCategoryDefinitionService

Parameters:

statryRptCategory - Report Category ID

Constraints: Not nullable, Maximum length: 30

statryRptActivityId - Activity ID

Constraints: Not nullable, Maximum length: 30

Returns:

A request builder to fetch a single ActivityDef 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.

getAllCategoryDef

@Nonnull
public GetAllRequestBuilder<CategoryDef> getAllCategoryDef()

Description copied from interface: StatutoryReportingCategoryDefinitionService

Fetch multiple CategoryDef entities.

Specified by:

getAllCategoryDef in interface StatutoryReportingCategoryDefinitionService

Returns:

A request builder to fetch multiple CategoryDef 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.

countCategoryDef

@Nonnull
public CountRequestBuilder<CategoryDef> countCategoryDef()

Description copied from interface: StatutoryReportingCategoryDefinitionService

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

Specified by:

countCategoryDef in interface StatutoryReportingCategoryDefinitionService

Returns:

A request builder to fetch the count of CategoryDef 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.

getCategoryDefByKey

@Nonnull
public GetByKeyRequestBuilder<CategoryDef> getCategoryDefByKey(String statryRptCategory)

Description copied from interface: StatutoryReportingCategoryDefinitionService

Fetch a single CategoryDef entity using key fields.

Specified by:

getCategoryDefByKey in interface StatutoryReportingCategoryDefinitionService

Parameters:

statryRptCategory - Report Category ID

Constraints: Not nullable, Maximum length: 30

Returns:

A request builder to fetch a single CategoryDef 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.

getAllPhaseDef

@Nonnull
public GetAllRequestBuilder<PhaseDef> getAllPhaseDef()

Description copied from interface: StatutoryReportingCategoryDefinitionService

Fetch multiple PhaseDef entities.

Specified by:

getAllPhaseDef in interface StatutoryReportingCategoryDefinitionService

Returns:

A request builder to fetch multiple PhaseDef 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.

countPhaseDef

@Nonnull
public CountRequestBuilder<PhaseDef> countPhaseDef()

Description copied from interface: StatutoryReportingCategoryDefinitionService

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

Specified by:

countPhaseDef in interface StatutoryReportingCategoryDefinitionService

Returns:

A request builder to fetch the count of PhaseDef 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.

getPhaseDefByKey

@Nonnull
public GetByKeyRequestBuilder<PhaseDef> getPhaseDefByKey(String statryRptCategory,
 String statryRptCatPhase,
 LocalDate statryRptCatPhaseValidFromDate)

Description copied from interface: StatutoryReportingCategoryDefinitionService

Fetch a single PhaseDef entity using key fields.

Specified by:

getPhaseDefByKey in interface StatutoryReportingCategoryDefinitionService

Parameters:

statryRptCategory - Report Category ID

Constraints: Not nullable, Maximum length: 30

statryRptCatPhase - Report Category Phase

Constraints: Not nullable, Maximum length: 5

statryRptCatPhaseValidFromDate - Valid From Date

Constraints: Not nullable

Returns:

A request builder to fetch a single PhaseDef 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