Interface AllocationLookupSession

All Superinterfaces:

AllocationSession, AutoCloseable, Closeable, OsidSession, OsidSession

public interface AllocationLookupSession
extends AllocationSession

This session defines methods for accessing space allocation and quotas.

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

Modifier and Type	Method	Description
boolean	canAccessFilingAllocations()	Tests if this user can perform functions in this session.
Directory	getDirectory()	Gets the directory associated with this session.
Allocation	getDirectoryAllocation()	Gets the allocation of the data store across all users.
AllocationList	getDirectoryAllocations()	Gets the allocation of the data store across all users and include any allocations for sub-stores.
String	getDirectoryPath()	Gets the absolute path of this directory.
Allocation	getUserAllocation()	Gets the user quota allocation of the data store for the current user.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

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.