Interface AllocationLookupSession

All Superinterfaces:

AllocationSession, AutoCloseable, Closeable, OsidSession, OsidSession

public interface AllocationLookupSession
extends AllocationSession

This session defines methods for accessing space allocation and quotas.

Like all OsidSessions, AllocationLookupSessions are dedicated to single processing threads and a single authenticated user.

Method Summary

Modifier and Type	Method	Description
AllocationList	getUserAllocations()	Gets the user quota allocation of the data store for each user.
AllocationList	getUserAllocationsByUtilization(long percentage)	Gets the quota allocations of the data store for all users matching or exceeding the given utilization.
AllocationList	getUserAllocationsForUser(Id agentId)	Gets the user quota allocations of the data store for the given user including any subdirectories.

Methods inherited from interface AllocationSession

canAccessFilingAllocations, getDirectory, getDirectoryAllocation, getDirectoryAllocations, getDirectoryPath, getUserAllocation

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatTypes, getLocales, isAuthenticated, startTransaction, supportsTransactions

Method Details

getUserAllocationsForUser

AllocationList getUserAllocationsForUser(Id agentId)
                                  throws OperationFailedException,
PermissionDeniedException

Gets the user quota allocations of the data store for the given user including any subdirectories. The directory available by the allocation may indicate a higher level directory than the one requested if the one requested is a sub-directory inside the qoutad data store.

Parameters:

agentId - the agent Id of the user

Returns:

the allocation

Throws:

NullArgumentException - agentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getUserAllocations

AllocationList getUserAllocations()
                           throws OperationFailedException,
PermissionDeniedException

Gets the user quota allocation of the data store for each user. The directory available by the allocation may indicate a higher level directory than the one requested if the one requested is a sub-directory inside the qoutad data store.

Returns:

the allocation

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getUserAllocationsByUtilization

AllocationList getUserAllocationsByUtilization(long percentage)
                                        throws OperationFailedException,
PermissionDeniedException

Gets the quota allocations of the data store for all users matching or exceeding the given utilization. The directory available by the allocation may indicate a higher level directory than the one requested if the one requested is a sub-directory inside the qoutad data store.

Parameters:

percentage - the utilization percentage (0-100)

Returns:

the allocation

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.