Interface PrincipalQueryManager

All Known Implementing Classes:
PrincipalManagerDelegator, PrincipalManagerImpl

@ProviderType public interface PrincipalQueryManager
Extension for the PrincipalManager that offers range search.
  • Method Summary

    Modifier and Type
    Method
    Description
    findPrincipals(@Nullable String simpleFilter, boolean fullText, int searchType, long offset, long limit)
    Gets the principals matching a simple filter expression applied against the principal name AND the specified search type.
  • Method Details

    • findPrincipals

      @NotNull @NotNull PrincipalIterator findPrincipals(@Nullable @Nullable String simpleFilter, boolean fullText, int searchType, long offset, long limit)
      Gets the principals matching a simple filter expression applied against the principal name AND the specified search type. Results are expected to be sorted by the principal name. An implementation may limit the number of principals returned. If there are no matching principals, an empty iterator is returned.
      Parameters:
      simpleFilter -
      fullText -
      searchType - Any of the following constants:
      offset - Offset from where to start returning results. 0 for no offset.
      limit - Maximal number of results to return. -1 for no limit.
      Returns:
      a PrincipalIterator over the Principals matching the given filter and search type.