org.alfresco.repo.security.permissions

Interface PermissionCheckCollection<T>

All Known Implementing Classes:

PermissionCheckCollection.PermissionCheckCollectionMixin

public interface PermissionCheckCollection<T>

Interface for collection-based results that describe permission filtering behaviour around cut-off limits.

Since:

4.0

Author:

Derek Hulley

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PermissionCheckCollection.PermissionCheckCollectionMixin<T> Helper 'introduction' to allow simple addition of the PermissionCheckCollection interface to existing collections.

Method Summary

Modifier and Type	Method and Description
int	getCutOffAfterCount() Get the maximum number of permission checks to perform before cutting the results off
long	getCutOffAfterTimeMs() Get the maximum time for permission checks to execute before cutting the results off.
int	getTargetResultCount() Get the desired number of results.

Method Detail

getTargetResultCount

int getTargetResultCount()

Get the desired number of results. Permission checks can stop once the number of return objects reaches this number.

Returns:

the number of results desired

getCutOffAfterTimeMs

long getCutOffAfterTimeMs()

Get the maximum time for permission checks to execute before cutting the results off.
Zero: Ignore this value.

Returns:

the time allowed for permission checks before cutoff

getCutOffAfterCount

int getCutOffAfterCount()

Get the maximum number of permission checks to perform before cutting the results off

Returns:

the maximum number of permission checks before cutoff