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

Interface	osid.filing.allocation.FilingAllocationManager
Implements	`osid.OsidManager`
Implements	`osid.filing.allocation.FilingAllocationProfile`
Description	The filing allocation manager provides access sessions to retrieve and manage allocations. The sessions included in this manager are: `AllocationSession:` a session for accessing usage information and quotas for the current user `AllocationLookupSession:` a session for accessing usage information and quotas `AllocationAdminSession` a session for assigning quotas `AllocationNotificationSession:` a session for subscribing to usage warnings and quota changes
Method	getAllocationSession
Description	Gets the session for accessing usage and quotas.
Return	`osid.filing.allocation.AllocationSession`		an `AllocationSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAllocation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAllocation()` is `true.`
Method	getAllocationSessionForDirectory
Description	Gets the session for accessing usage and quotas for a given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.
Parameters	`string`	`directoryPath`	the pathname to the directory
Return	`osid.filing.allocation.AllocationSession`		an `AllocationSession`
Errors	INVALID_ARGUMENT		`directoryPath` is not a directory or an alias to a directory
	NOT_FOUND		`directoryPath` is not found
	NULL_ARGUMENT		`directoryPath` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAllocation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAllocation()` and `supportsVisibleFederation()` are `true.`
Method	getAllocationLookupSession
Description	Gets the session for accessing usage and quotas.
Return	`osid.filing.allocation.AllocationLookupSession`		an `AllocationLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAllocationLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAllocationLookup()` is `true.`
Method	getAllocationLookupSessionForDirectory
Description	Gets the session for accessing usage and quotas for a given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.
Parameters	`string`	`directoryPath`	the pathname to the directory
Return	`osid.filing.allocation.AllocationLookupSession`		an `AllocationLookupSession`
Errors	INVALID_ARGUMENT		`directoryPath` is not a directory or an alias to a directory
	NOT_FOUND		`directoryPath` is not found
	NULL_ARGUMENT		`directoryPath` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAllocationLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAllocationLookup()` and `supportsVisibleFederation()` are `true.`
Method	getAllocationAdminSession
Description	Gets the session for assigning quotas.
Return	`osid.filing.allocation.AllocationAdminSession`		an `AllocationAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAllocationAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAllocationAdmin()` is `true.`
Method	getAllocationAdminSessionForDirectory
Description	Gets the session for assigning quotas for the given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.
Parameters	`string`	`directoryPath`	the pathname to the directory
Return	`osid.filing.allocation.AllocationAdminSession`		an `AllocationAdminSession`
Errors	INVALID_ARGUMENT		`directoryPath` is not a directory or an alias to a directory
	NOT_FOUND		`directoryPath` is not found
	NULL_ARGUMENT		`directoryPath` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAllocationAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAllocationAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getAllocationNotificationSession
Description	Gets the session for receiving messages about changes to directories.
Parameters	`osid.filing.allocation.AllocationReceiver`	`allocationReceiver`	the notification callback
Return	`osid.filing.allocation.AllocationNotificationSession`		an `AllocationNotificationSession`
Errors	NULL_ARGUMENT		`allocationReceiver` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAllocationNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDirectoryNotification()` is `true.`
Method	getAllocationNotificationSessionForDirectory
Description	Gets the session for receiving messages about usage warnings and quota changes for the given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.
Parameters	`osid.filing.allocation.AllocationReceiver`	`allocationReceiver`	the notification callback
Parameters	`string`	`directoryPath`	the pathname to the directory
Return	`osid.filing.allocation.AllocationNotificationSession`		an `AllocationNotificationSession`
Errors	INVALID_ARGUMENT		`directoryPath` is not a directory or an alias to a directory
	NOT_FOUND		`directoryPath` is not found
	NULL_ARGUMENT		`allocationReceiver` or `directoryPath` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAllocationNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAllocationNotification()` and `supportsVisibleFederation()` are `true.`