org.alfresco.repo.security.permissions
Interface PermissionCheckedCollection

All Known Implementing Classes:

PermissionCheckedCollection.PermissionCheckedCollectionMixin

public interface PermissionCheckedCollection

Interface for collection-based results that carry extra information about the state of permission cut-offs.

Since:

4.0

Nested Class Summary

static class

PermissionCheckedCollection.PermissionCheckedCollectionMixin Helper 'introduction' to allow simple addition of the PermissionCheckedCollection interface to existing collections.

Method Summary

boolean	isCutOff() Check if the results have been truncated by permission check limits.
int	sizeOriginal() Get the number of objects in the original (unfiltered) collection.
int	sizeUnchecked() Get the number of objects in the original (unfiltered) collection that did not have any permission checks.

Method Detail

isCutOff

boolean isCutOff()

Check if the results have been truncated by permission check limits. This can only be called when #isFiltered() is true.

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