Package io.jmix.reports

Interface ReportGroupRepository

All Known Implementing Classes:
ReportGroupRepositoryImpl
public interface ReportGroupRepository
Provides unified access to both types of report groups: stored in database and defined in code. Loading and modification operations apply registered security constraints.
Application should generally should use this interface to work with groups, instead of DataManager.

  • Method Details

    • loadAll

      List<ReportGroup> loadAll()
      Load all report groups, sorted by localized title.
      Returns:
      list of groups

    • loadList

      List<ReportGroup> loadList(ReportGroupLoadContext loadContext)
      Load list of report groups, with filtering, pagination and sorting options available.
      Parameters:
      loadContext - context containing filtering, pagination and sorting options
      Returns:
      list of groups

    • getTotalCount

      int getTotalCount(ReportGroupFilter filter)
      Calculate total count of entities that conform to passed filter.
      Parameters:
      filter - object with filter values
      Returns:
      count of suitable entities

    • existsGroupByCode

      boolean existsGroupByCode(String code)
      Checks if there are any report groups with the given code.
      Parameters:
      code - report group code
      Returns:
      true if a report group with the given code exists, false otherwise

    • loadGroupIdByCode

      Optional<UUID> loadGroupIdByCode(String code)
      Loads report group id by its code.
      Parameters:
      code - report group code
      Returns:
      Optional id for report group.