OSID Logo
OSID Specifications
filing allocation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.filing.allocation.AllocationNotificationSession
Implementsosid.OsidSession
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.

MethodgetDirectoryPath
Description

Gets the absolute path of this directory.

Returnstringthe absolute path of this directory
CompliancemandatoryThis method must be implemented.
MethodgetDirectory
Description

Gets the Directory associated with this session.

Returnosid.filing.Directorythe Directory associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForAllocationNotifications
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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodregisterForAllocationWarnings
Description

Register for notifications of allocation warnings. AllocationReceiver.warning() is invoked when a new warning is issued.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForAllocationClearWarnings
Description

Register for notifications of clearing of allocation warnings. AllocationReceiver.clearWarning() is invoked when a warning is cleared.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAllocations
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.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAllocationsForDirectory
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.

Parametersosid.id.Iddircetorythe path
ErrorsNULL_ARGUMENT directory is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedUserAllocations
Description

Registers for notification of new, updated or changed user quotas. AllocationReceiver.changedUserAllocation() is invoked when a quota is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedUserAllocationsForUser
Description

Registers for notification of new, updated or changed quotas for a specific user. AllocationReceiver.changedUserAllocation() is invoked when a quota is changed.

Parametersosid.id.IdagentIdthe Id of the user
ErrorsNULL_ARGUMENT agentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.