Interface | osid.filing.allocation.AllocationNotificationSession | ||
---|---|---|---|
Implements | osid.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. | ||
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 | ||
Return | osid.filing.Directory | the Directory associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForAllocationNotifications | ||
Description |
Tests if this user can register for | ||
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.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForAllocationClearWarnings | ||
Description |
Register for notifications of clearing of allocation
warnings. | ||
Errors | OPERATION_FAILED | unable to complete request | |
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. | ||
Errors | OPERATION_FAILED | unable to complete request | |
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. | ||
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. | ||
Errors | OPERATION_FAILED | unable to complete request | |
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. | ||
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. |