Package org.chenile.query.service

Interface CannedReportStore

public interface CannedReportStore
Retrieve and store canned reports. Get a list of all the reports for a user and tenant Id combination
Author:
meratransport

  • Method Summary

    Modifier and Type
    Method
    Description
    List<CannedReport>
    getAllCannedReportsForUserTenant(String queryName)
    For the current User and tenant, retrieve the following canned reports from the DB: All canned reports whose tenant Id and the user ID exactly match with the current user Id and the tenant Id all the canned reports whose tenant ID matches the current tenant and whose User ID is null
    CannedReport
    retrieve(String cannedReportName, String queryName)
    Retrieve the canned report by name.
    void
    store(CannedReport cannedReport)
    Store the canned report details into the DB.

  • Method Details

    • retrieve

      CannedReport retrieve(String cannedReportName, String queryName)
      Retrieve the canned report by name. Make sure that the canned report is applicable to the current user and tenant. If the userId is null in the retrieved canned report, then the CannedReport.isApplicableToAll() must be set to true else the user Id must match the current userId.
      Parameters:
      cannedReportName - the name of the canned report
      queryName - the name of the query
      Returns:
      the report details or null if not found

    • store

      void store(CannedReport cannedReport)
      Store the canned report details into the DB.
      Parameters:
      cannedReport - the canned report definition

    • getAllCannedReportsForUserTenant

      List<CannedReport> getAllCannedReportsForUserTenant(String queryName)
      For the current User and tenant, retrieve the following canned reports from the DB: All canned reports whose tenant Id and the user ID exactly match with the current user Id and the tenant Id all the canned reports whose tenant ID matches the current tenant and whose User ID is null
      Parameters:
      queryName - - the name of the query
      Returns:
      the list of canned reports that match the query name