Package org.opencastproject.list.api

Interface ResourceListQuery

All Known Implementing Classes:
AclsListQuery, AgentsListQuery, EmptyResourceListQuery, EventListQuery, GroupsListQuery, JobsListQuery, ResourceListQueryImpl, SeriesListQuery, ServersListQuery, ServicesListQuery, ThemesListQuery, UsersListQuery
public interface ResourceListQuery
Query for the resource list

  • Method Details

    • getFilters

      List<ResourceListFilter<?>> getFilters()
      Returns all the ResourceListFilter set for the query.
      Returns:
      all the query filters

    • getAvailableFilters

      List<ResourceListFilter<?>> getAvailableFilters()
      Returns all the available ResourceListFilter filters with this query. The objects returned in the list are simple instance without any filter value set.
      Returns:
      all the available filters

    • getFilter

      ResourceListFilter<?> getFilter(String name)
      Returns the filter with the given name
      Parameters:
      name -
      Returns:
      the query filter or null if the filter does not exist

    • getLimit

      Optional<Integer> getLimit()
      Returns the limit for the resource query
      Returns:
      the list limit

    • getOffset

      Optional<Integer> getOffset()
      Returns the offset for the resource query
      Returns:
      the list offset

    • getSortBy

      Optional<String> getSortBy()
      Returns the name of the field by which the list should be sorted
      Returns:
      the name of the field to use to sort the list

    • hasFilter

      Boolean hasFilter(String name)
      Returns if the given filter is or not set
      Parameters:
      name - the filter name
      Returns:
      true if set