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

Interface	osid.filing.allocation.AllocationNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.filing.allocation.FilingAllocationManager`
Used By	`osid.filing.allocation.FilingAllocationProxyManager`
Description	This session defines methods to receive notifications of allocation warnings and changed quota assignments. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.
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	canRegisterForAllocationNotifications
Description	Tests if this user can register for `Directory` notifications. 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 notification operations.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	registerForAllocationWarnings
Description	Register for notifications of allocation warnings. `AllocationReceiver.warning()` is invoked when a new warning is issued.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForAllocationClearWarnings
Description	Register for notifications of clearing of allocation warnings. `AllocationReceiver.clearWarning()` is invoked when a warning is cleared.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAllocations
Description	Registers for notification of new, updated or changed allocations across an entire file system not specific to any user. `AllocationReceiver.changedAllocation()` is invoked when a quota is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAllocationsForDirectory
Description	Registers for notification of new, updated or changed allocations across an entire file system not specific to any user. `AllocationReceiver.changedAllocation()` is invoked when a quota is changed.
Parameters	`osid.id.Id`	`dircetory`	the path
Errors	NULL_ARGUMENT		`directory` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedUserAllocations
Description	Registers for notification of new, updated or changed user quotas. `AllocationReceiver.changedUserAllocation()` is invoked when a quota is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedUserAllocationsForUser
Description	Registers for notification of new, updated or changed quotas for a specific user. `AllocationReceiver.changedUserAllocation()` is invoked when a quota is changed.
Parameters	`osid.id.Id`	`agentId`	the `Id` of the user
Errors	NULL_ARGUMENT		`agentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.