Interface PermissionCheckedCollection<T>

All Known Implementing Classes:
PermissionCheckedCollection.PermissionCheckedCollectionMixin

public interface PermissionCheckedCollection<T>
Interface for collection-based results that carry extra information about the state of permission cut-offs.
Since:
4.0
Author:
Derek Hulley
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    Helper 'introduction' to allow simple addition of the PermissionCheckedCollection interface to existing collections.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Check if the results have been truncated by permission check limits.
    int
    Get the number of objects in the original (unfiltered) collection.
    int
    Get the number of objects in the original (unfiltered) collection that did not have any permission checks.
  • Method Details

    • isCutOff

      boolean isCutOff()
      Check if the results have been truncated by permission check limits.
      Returns:
      true - if the results (usually a collection) have been cut off by permission check limits
    • sizeUnchecked

      int sizeUnchecked()
      Get the number of objects in the original (unfiltered) collection that did not have any permission checks.
      Returns:
      number of entries from the original collection that were not checked
    • sizeOriginal

      int sizeOriginal()
      Get the number of objects in the original (unfiltered) collection.
      Returns:
      number of entries in the original, pre-checked collection