OSID - osid.filing.allocation.AllocationSession Service Interface Definition

Interface	osid.filing.allocation.AllocationSession
Implements	`osid.OsidSession`
Implemented By	`osid.filing.allocation.AllocationLookupSession`
Used By	`osid.filing.allocation.FilingAllocationManager`
Used By	`osid.filing.allocation.FilingAllocationProxyManager`
Description	This session defines methods for accessing space allocation and quotas.
Method	getDirectoryPath
Description	Gets the absolute path of this directory.
Return	`string`	the absolute path of this directory
Compliance	`mandatory`	This method must be implemented.
Method	getDirectory
Description	Gets the directory associated with this session.
Return	`osid.filing.Directory`	the directory associated with this session
Errors	OPERATION_FAILED	unable to complete request
Errors	PERMISSION_DENIED	authorization failure
Compliance	`mandatory`	This method must be implemented.
Method	canAccessFilingAllocations
Description	Tests if this user can perform functions in this session. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
Return	`boolean`	`false` if filing allocation methods are not authorized, `true` otherwise
Compliance	`mandatory`	This method must be implemented.
Method	getDirectoryAllocation
Description	Gets the allocation of the data store across all users. The directory available by the allocation may indicate a higher level directory than the one associated with this session. If no specific aclloation exists, the returned `Allocation` may indicate the limits of the file system.
Return	`osid.filing.allocation.Allocation`	the allocation
Errors	OPERATION_FAILED	unable to complete request
Errors	PERMISSION_DENIED	authorization failure
Compliance	`mandatory`	This method must be implemented.
Method	getDirectoryAllocations
Description	Gets the allocation of the data store across all users and include any allocations for sub-stores.
Return	`osid.filing.allocation.AllocationList`	the allocation list
Errors	OPERATION_FAILED	unable to complete request
Errors	PERMISSION_DENIED	authorization failure
Compliance	`mandatory`	This method must be implemented.
Method	getUserAllocation
Description	Gets the user quota allocation of the data store for the current 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.
Return	`osid.filing.allocation.Allocation`	the allocation
Errors	NOT_FOUND	`agentId` is not found
	OPERATION_FAILED	unable to complete request
	PERMISSION_DENIED	authorization failure
Compliance	`mandatory`	This method must be implemented.