Package org.openiam.srvc.report

Interface ReportWebService

  • All Known Implementing Classes:
    ReportWebServiceImpl
    public interface ReportWebService
    Web service for managing reports

    • Method Detail

      • executeQuery

        GetReportDataResponse executeQuery​(ReportQueryDto reportQuery)
        Executes query and returns data.
        Parameters:
        reportQuery - Query to use for data retrieval.
        Returns:
        Returns data for report.

      • getReportUrl

        String getReportUrl​(ReportQueryDto reportQuery,
                    String taskName,
                    String reportBaseUrl,
                    String locale)
        Retrieves report URL.
        Parameters:
        reportQuery - Query to use for report URL retrieval.
        taskName - Task name.
        reportBaseUrl - Report base URL.
        locale - - Locale.
        Returns:
        Report URL.

      • getReports

        GetAllReportsResponse getReports​(int from,
                                 int size)
        Retrieves all reports in given range.
        Parameters:
        from - From range option.
        size - Size range option.
        Returns:
        Reports for given range.

      • getReportCount

        Integer getReportCount()
        Counts number of reports.
        Returns:
        Number of reports.

      • getReportsByUserId

        GetAllReportsResponse getReportsByUserId​(String requestorId)
        Retrieves all reports for given user ID.
        Parameters:
        requestorId - User ID.
        Returns:
        All reports for given requestorId (User ID).

      • createOrUpdateReportInfo

        Response createOrUpdateReportInfo​(ReportInfoDto report)
        Creates or updates report info.
        Parameters:
        report - Report info to create or update.
        Returns:
        Response.

      • validateUpdateReportInfo

        Response validateUpdateReportInfo​(ReportInfoDto report)
        Validates update report info.
        Parameters:
        report - Report info that will be validated.
        Returns:
        Response.

      • createOrUpdateReportInfoParam

        Response createOrUpdateReportInfoParam​(ReportCriteriaParamDto reportParam)
        Creates or updates report info. parameter.
        Parameters:
        reportParam - Report info. parameter that will be created or updated.
        Returns:
        Response.

      • deleteReportParam

        Response deleteReportParam​(String reportParamId)
        Deletes report parameter.
        Parameters:
        reportParamId - Report parameter Id.
        Returns:
        Response.

      • getReportParametersByReportId

        GetReportParametersResponse getReportParametersByReportId​(String reportId)
        Retrieves report parameter for given report Id.
        Parameters:
        reportId - Report Id.
        Returns:
        Report parameters.

      • getReportParametersByReportName

        GetReportParametersResponse getReportParametersByReportName​(String reportName)
        Retrieves report parameters for given report name.
        Parameters:
        reportName - Report name.
        Returns:
        Report parameters.

      • getReportByName

        GetReportInfoResponse getReportByName​(String reportName)
        Retrieve report info.
        Parameters:
        reportName - Report name.
        Returns:
        Report info.

      • getReport

        GetReportInfoResponse getReport​(String reportId)
        Retrieves report info for given report Id.
        Parameters:
        reportId - Report Id.
        Returns:
        Report info.

      • deleteReport

        Response deleteReport​(String reportId)
        Deletes report with given report Id.
        Parameters:
        reportId - Report Id.
        Returns:
        Response.

      • getSubCriteriaParamReportCount

        Integer getSubCriteriaParamReportCount()
        Retrieves number of sub criteria report parameters.
        Returns:
        Number of parameters.

      • deleteSubCriteriaParamReport

        Response deleteSubCriteriaParamReport​(String reportId)
        Deletes sub criteria report.
        Parameters:
        reportId - sub criteria report id.
        Returns:
        Response.

      • getAllSubCriteriaParamReport

        GetAllSubCriteriaParamReportsResponse getAllSubCriteriaParamReport​(String reportId)
        Retrieves all parameters that are sub criteria reports for given report Id.
        Parameters:
        reportId - Report Id.
        Returns:
        Parameters that are sub criteria reports for given report Id

      • createOrUpdateSubCriteriaParam

        Response createOrUpdateSubCriteriaParam​(ReportSubCriteriaParamDto subCriteriaParamReport)
        Creates or updates sub criteria report param.
        Parameters:
        subCriteriaParamReport - Report sub criteria param that will be created or updated.
        Returns:
        Response.

      • getAllReportCriteriaParam

        List<ReportCriteriaParamDto> getAllReportCriteriaParam()
        Retrieves all report criteria params list.
        Returns:
        List of report criteria params.