public interface AllocationSession extends OsidSession
This session defines methods for accessing space allocation and quotas.
Modifier and Type | Method and 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.
|
java.lang.String |
getDirectoryPath()
Gets the absolute path of this directory.
|
Allocation |
getUserAllocation()
Gets the user quota allocation of the data store for the current user.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
java.lang.String getDirectoryPath()
mandatory
- This method must be implemented. Directory getDirectory() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAccessFilingAllocations()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations to
unauthorized users. false
if filing allocation methods are not
authorized, true
otherwisemandatory
- This method must be implemented. Allocation getDirectoryAllocation() throws OperationFailedException, PermissionDeniedException
Allocation
may indicate the limits
of the file system.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AllocationList getDirectoryAllocations() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. Allocation getUserAllocation() throws NotFoundException, OperationFailedException, PermissionDeniedException
NotFoundException
- agentId
is not foundOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.