Enum LimitBy

java.lang.Object
java.lang.Enum<LimitBy>
org.alfresco.service.cmr.search.LimitBy
All Implemented Interfaces:
Serializable, Comparable<LimitBy>, java.lang.constant.Constable

@AlfrescoPublicApi public enum LimitBy extends Enum<LimitBy>
Enum to describe how the maximum size of the returned result set should be determined.
Author:
Andy Hind
  • Enum Constant Details

    • UNLIMITED

      public static final LimitBy UNLIMITED
      The final number of search results is not important.
    • FINAL_SIZE

      public static final LimitBy FINAL_SIZE
      Limit the total number of search results returned after pruning by permissions.
    • NUMBER_OF_PERMISSION_EVALUATIONS

      public static final LimitBy NUMBER_OF_PERMISSION_EVALUATIONS
      Limit the number of results that will be passed through for permission checks.
      Used internally to prevent excessive permission checking (see property lucene.query.maxInitialSearchResults).
  • Method Details

    • values

      public static LimitBy[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static LimitBy valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null