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

All Implemented Interfaces:: OperationsOnEntityCollections, ServiceWithNavigableEntities, StatutoryReportingTaskService

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

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 Task. - Task – Manage an Ad hoc task for the specified report. - Phase – Manage phases for the specified report. - Activity – Manage the activities for the specified report. - Run – Manage runs for the specified report. - RunParameter – Check the Run parameters used for the specified report..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	CE_STATUTORYREPORTINGTASK_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_STATUTORYREPORTINGTASK
Business Object:	Statutory Reporting Task

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.StatutoryReportingTaskService
DEFAULT_SERVICE_PATH
Constructor Summary

Constructors

Constructor

Description

DefaultStatutoryReportingTaskService()

Creates a service using StatutoryReportingTaskService.DEFAULT_SERVICE_PATH to send the requests.
Method Summary

Modifier and Type

Method

Description

BatchRequestBuilder

batch()

Creates a batch request builder object.

CountRequestBuilder<Activity>

countActivity()

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

CountRequestBuilder<Phase>

countPhase()

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

CountRequestBuilder<Run>

countRun()

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

CountRequestBuilder<RunParameter>

countRunParameter()

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

CountRequestBuilder<Task>

countTask()

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

CreateRequestBuilder<Activity>

createActivity(Activity activity)

Create a new Activity entity and save it to the S/4HANA system.

CreateRequestBuilder<Phase>

createPhase(Phase phase)

Create a new Phase entity and save it to the S/4HANA system.

CreateRequestBuilder<Run>

createRun(Run run)

Create a new Run entity and save it to the S/4HANA system.

CreateRequestBuilder<Task>

createTask(Task task)

Create a new Task entity and save it to the S/4HANA system.

DeleteRequestBuilder<Task>

deleteTask(Task task)

Deletes an existing Task entity in the S/4HANA system.

GetByKeyRequestBuilder<Activity>

getActivityByKey(UUID statryRptActivityUUID)

Fetch a single Activity entity using key fields.

GetAllRequestBuilder<Activity>

getAllActivity()

Fetch multiple Activity entities.

GetAllRequestBuilder<Phase>

getAllPhase()

Fetch multiple Phase entities.

GetAllRequestBuilder<Run>

getAllRun()

Fetch multiple Run entities.

GetAllRequestBuilder<RunParameter>

getAllRunParameter()

Fetch multiple RunParameter entities.

GetAllRequestBuilder<Task>

getAllTask()

Fetch multiple Task entities.

GetByKeyRequestBuilder<Phase>

getPhaseByKey(UUID statryRptPhaseUUID)

Fetch a single Phase entity using key fields.

GetByKeyRequestBuilder<Run>

getRunByKey(UUID statryRptRunUUID)

Fetch a single Run entity using key fields.

GetByKeyRequestBuilder<RunParameter>

getRunParameterByKey(UUID statryRptRunParamUUID)

Fetch a single RunParameter entity using key fields.

String

getServicePath()

GetByKeyRequestBuilder<Task>

getTaskByKey(UUID statryRptTaskUUID)

Fetch a single Task entity using key fields.

DefaultStatutoryReportingTaskService

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
- DefaultStatutoryReportingTaskService
  
  public DefaultStatutoryReportingTaskService()
  
  Creates a service using StatutoryReportingTaskService.DEFAULT_SERVICE_PATH to send the requests.
Method Details
- withServicePath
  
  @Nonnull public DefaultStatutoryReportingTaskService withServicePath(@Nonnull String servicePath)
  
  Description copied from interface: StatutoryReportingTaskService
  
  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 StatutoryReportingTaskService
  
  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: StatutoryReportingTaskService
  
  Creates a batch request builder object.
  
  Specified by:
  
  batch in interface StatutoryReportingTaskService
  
  Returns:
  
  A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.
- getAllActivity
  
  @Nonnull public GetAllRequestBuilder<Activity> getAllActivity()
  
  Description copied from interface: StatutoryReportingTaskService
  
  Fetch multiple Activity entities.
  
  Specified by:
  
  getAllActivity in interface StatutoryReportingTaskService
  
  Returns:
  
  A request builder to fetch multiple Activity 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.
- countActivity
  
  @Nonnull public CountRequestBuilder<Activity> countActivity()
  
  Description copied from interface: StatutoryReportingTaskService
  
  Fetch the number of entries from the Activity entity collection matching the filter and search expressions.
  
  Specified by:
  
  countActivity in interface StatutoryReportingTaskService
  
  Returns:
  
  A request builder to fetch the count of Activity 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.
- getActivityByKey
  
  @Nonnull public GetByKeyRequestBuilder<Activity> getActivityByKey(UUID statryRptActivityUUID)
  
  Description copied from interface: StatutoryReportingTaskService
  
  Fetch a single Activity entity using key fields.
  
  Specified by:
  
  getActivityByKey in interface StatutoryReportingTaskService
  
  Parameters:
  
  statryRptActivityUUID - NodeID
  Constraints: Not nullable
  
  Returns:
  
  A request builder to fetch a single Activity 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.
- createActivity
  
  @Nonnull public CreateRequestBuilder<Activity> createActivity(@Nonnull Activity activity)
  
  Description copied from interface: StatutoryReportingTaskService
  
  Create a new Activity entity and save it to the S/4HANA system.
  
  Specified by:
  
  createActivity in interface StatutoryReportingTaskService
  
  Parameters:
  
  activity - Activity entity object that will be created in the S/4HANA system.
  
  Returns:
  
  A request builder to create a new Activity entity. To perform execution, call the execute method on the request builder object.
- getAllPhase
  
  @Nonnull public GetAllRequestBuilder<Phase> getAllPhase()
  
  Description copied from interface: StatutoryReportingTaskService
  
  Fetch multiple Phase entities.
  
  Specified by:
  
  getAllPhase in interface StatutoryReportingTaskService
  
  Returns:
  
  A request builder to fetch multiple Phase 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.
- countPhase
  
  @Nonnull public CountRequestBuilder<Phase> countPhase()
  
  Description copied from interface: StatutoryReportingTaskService
  
  Fetch the number of entries from the Phase entity collection matching the filter and search expressions.
  
  Specified by:
  
  countPhase in interface StatutoryReportingTaskService
  
  Returns:
  
  A request builder to fetch the count of Phase 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.
- getPhaseByKey
  
  @Nonnull public GetByKeyRequestBuilder<Phase> getPhaseByKey(UUID statryRptPhaseUUID)
  
  Description copied from interface: StatutoryReportingTaskService
  
  Fetch a single Phase entity using key fields.
  
  Specified by:
  
  getPhaseByKey in interface StatutoryReportingTaskService
  
  Parameters:
  
  statryRptPhaseUUID - NodeID
  Constraints: Not nullable
  
  Returns:
  
  A request builder to fetch a single Phase 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.
- createPhase
  
  @Nonnull public CreateRequestBuilder<Phase> createPhase(@Nonnull Phase phase)
  
  Description copied from interface: StatutoryReportingTaskService
  
  Create a new Phase entity and save it to the S/4HANA system.
  
  Specified by:
  
  createPhase in interface StatutoryReportingTaskService
  
  Parameters:
  
  phase - Phase entity object that will be created in the S/4HANA system.
  
  Returns:
  
  A request builder to create a new Phase entity. To perform execution, call the execute method on the request builder object.
- getAllRun
  
  @Nonnull public GetAllRequestBuilder<Run> getAllRun()
  
  Description copied from interface: StatutoryReportingTaskService
  
  Fetch multiple Run entities.
  
  Specified by:
  
  getAllRun in interface StatutoryReportingTaskService
  
  Returns:
  
  A request builder to fetch multiple Run 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.
- countRun
  
  @Nonnull public CountRequestBuilder<Run> countRun()
  
  Description copied from interface: StatutoryReportingTaskService
  
  Fetch the number of entries from the Run entity collection matching the filter and search expressions.
  
  Specified by:
  
  countRun in interface StatutoryReportingTaskService
  
  Returns:
  
  A request builder to fetch the count of Run 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.
- getRunByKey
  
  @Nonnull public GetByKeyRequestBuilder<Run> getRunByKey(UUID statryRptRunUUID)
  
  Description copied from interface: StatutoryReportingTaskService
  
  Fetch a single Run entity using key fields.
  
  Specified by:
  
  getRunByKey in interface StatutoryReportingTaskService
  
  Parameters:
  
  statryRptRunUUID - NodeID
  Constraints: Not nullable
  
  Returns:
  
  A request builder to fetch a single Run 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.
- createRun
  
  @Nonnull public CreateRequestBuilder<Run> createRun(@Nonnull Run run)
  
  Description copied from interface: StatutoryReportingTaskService
  
  Create a new Run entity and save it to the S/4HANA system.
  
  Specified by:
  
  createRun in interface StatutoryReportingTaskService
  
  Parameters:
  
  run - Run entity object that will be created in the S/4HANA system.
  
  Returns:
  
  A request builder to create a new Run entity. To perform execution, call the execute method on the request builder object.
- getAllRunParameter
  
  @Nonnull public GetAllRequestBuilder<RunParameter> getAllRunParameter()
  
  Description copied from interface: StatutoryReportingTaskService
  
  Fetch multiple RunParameter entities.
  
  Specified by:
  
  getAllRunParameter in interface StatutoryReportingTaskService
  
  Returns:
  
  A request builder to fetch multiple RunParameter 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.
- countRunParameter
  
  @Nonnull public CountRequestBuilder<RunParameter> countRunParameter()
  
  Description copied from interface: StatutoryReportingTaskService
  
  Fetch the number of entries from the RunParameter entity collection matching the filter and search expressions.
  
  Specified by:
  
  countRunParameter in interface StatutoryReportingTaskService
  
  Returns:
  
  A request builder to fetch the count of RunParameter 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.
- getRunParameterByKey
  
  @Nonnull public GetByKeyRequestBuilder<RunParameter> getRunParameterByKey(UUID statryRptRunParamUUID)
  
  Description copied from interface: StatutoryReportingTaskService
  
  Fetch a single RunParameter entity using key fields.
  
  Specified by:
  
  getRunParameterByKey in interface StatutoryReportingTaskService
  
  Parameters:
  
  statryRptRunParamUUID - NodeID
  Constraints: Not nullable
  
  Returns:
  
  A request builder to fetch a single RunParameter 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.
- getAllTask
  
  @Nonnull public GetAllRequestBuilder<Task> getAllTask()
  
  Description copied from interface: StatutoryReportingTaskService
  
  Fetch multiple Task entities.
  
  Specified by:
  
  getAllTask in interface StatutoryReportingTaskService
  
  Returns:
  
  A request builder to fetch multiple Task 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.
- countTask
  
  @Nonnull public CountRequestBuilder<Task> countTask()
  
  Description copied from interface: StatutoryReportingTaskService
  
  Fetch the number of entries from the Task entity collection matching the filter and search expressions.
  
  Specified by:
  
  countTask in interface StatutoryReportingTaskService
  
  Returns:
  
  A request builder to fetch the count of Task 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.
- getTaskByKey
  
  @Nonnull public GetByKeyRequestBuilder<Task> getTaskByKey(UUID statryRptTaskUUID)
  
  Description copied from interface: StatutoryReportingTaskService
  
  Fetch a single Task entity using key fields.
  
  Specified by:
  
  getTaskByKey in interface StatutoryReportingTaskService
  
  Parameters:
  
  statryRptTaskUUID - NodeID
  Constraints: Not nullable
  
  Returns:
  
  A request builder to fetch a single Task 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.
- createTask
  
  @Nonnull public CreateRequestBuilder<Task> createTask(@Nonnull Task task)
  
  Description copied from interface: StatutoryReportingTaskService
  
  Create a new Task entity and save it to the S/4HANA system.
  
  Specified by:
  
  createTask in interface StatutoryReportingTaskService
  
  Parameters:
  
  task - Task entity object that will be created in the S/4HANA system.
  
  Returns:
  
  A request builder to create a new Task entity. To perform execution, call the execute method on the request builder object.
- deleteTask
  
  @Nonnull public DeleteRequestBuilder<Task> deleteTask(@Nonnull Task task)
  
  Description copied from interface: StatutoryReportingTaskService
  
  Deletes an existing Task entity in the S/4HANA system.
  
  Specified by:
  
  deleteTask in interface StatutoryReportingTaskService
  
  Parameters:
  
  task - Task entity object that will be deleted in the S/4HANA system.
  
  Returns:
  
  A request builder to delete an existing Task entity. To perform execution, call the execute method on the request builder object.
- getServicePath
  
  @Nonnull public String getServicePath()
  
  Specified by:
  
  getServicePath in interface ServiceWithNavigableEntities

Class DefaultStatutoryReportingTaskService

Details:

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultStatutoryReportingTaskService

Method Details

withServicePath

batch

getAllActivity

countActivity

getActivityByKey

createActivity

getAllPhase

countPhase

getPhaseByKey

createPhase

getAllRun

countRun

getRunByKey

createRun

getAllRunParameter

countRunParameter

getRunParameterByKey

getAllTask

countTask

getTaskByKey

createTask

deleteTask

getServicePath