Interface StatutoryReportingTaskService

All Known Implementing Classes:
DefaultStatutoryReportingTaskService

public interface 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 Details

  • Method Details

    • withServicePath

      @Nonnull StatutoryReportingTaskService withServicePath(@Nonnull String servicePath)
      Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.
      Parameters:
      servicePath - Service path that will override the default.
      Returns:
      A new service instance with the specified service path.
    • batch

      @Nonnull BatchRequestBuilder batch()
      Creates a batch request builder object.
      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 GetAllRequestBuilder<Activity> getAllActivity()
      Fetch multiple Activity entities.
      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 CountRequestBuilder<Activity> countActivity()
      Fetch the number of entries from the Activity entity collection matching the filter and search expressions.
      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 GetByKeyRequestBuilder<Activity> getActivityByKey(UUID statryRptActivityUUID)
      Fetch a single Activity entity using key fields.
      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 CreateRequestBuilder<Activity> createActivity(@Nonnull Activity activity)
      Create a new Activity entity and save it to the S/4HANA system.
      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 GetAllRequestBuilder<Phase> getAllPhase()
      Fetch multiple Phase entities.
      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 CountRequestBuilder<Phase> countPhase()
      Fetch the number of entries from the Phase entity collection matching the filter and search expressions.
      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 GetByKeyRequestBuilder<Phase> getPhaseByKey(UUID statryRptPhaseUUID)
      Fetch a single Phase entity using key fields.
      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 CreateRequestBuilder<Phase> createPhase(@Nonnull Phase phase)
      Create a new Phase entity and save it to the S/4HANA system.
      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 GetAllRequestBuilder<Run> getAllRun()
      Fetch multiple Run entities.
      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 CountRequestBuilder<Run> countRun()
      Fetch the number of entries from the Run entity collection matching the filter and search expressions.
      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 GetByKeyRequestBuilder<Run> getRunByKey(UUID statryRptRunUUID)
      Fetch a single Run entity using key fields.
      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 CreateRequestBuilder<Run> createRun(@Nonnull Run run)
      Create a new Run entity and save it to the S/4HANA system.
      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 GetAllRequestBuilder<RunParameter> getAllRunParameter()
      Fetch multiple RunParameter entities.
      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 CountRequestBuilder<RunParameter> countRunParameter()
      Fetch the number of entries from the RunParameter entity collection matching the filter and search expressions.
      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 GetByKeyRequestBuilder<RunParameter> getRunParameterByKey(UUID statryRptRunParamUUID)
      Fetch a single RunParameter entity using key fields.
      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 GetAllRequestBuilder<Task> getAllTask()
      Fetch multiple Task entities.
      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 CountRequestBuilder<Task> countTask()
      Fetch the number of entries from the Task entity collection matching the filter and search expressions.
      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 GetByKeyRequestBuilder<Task> getTaskByKey(UUID statryRptTaskUUID)
      Fetch a single Task entity using key fields.
      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 CreateRequestBuilder<Task> createTask(@Nonnull Task task)
      Create a new Task entity and save it to the S/4HANA system.
      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 DeleteRequestBuilder<Task> deleteTask(@Nonnull Task task)
      Deletes an existing Task entity in the S/4HANA system.
      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.