Interface | osid.authorization.FunctionNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive asynchronous
notifications on adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getVaultId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Vault Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getVault | ||
Description |
Gets the | ||
Return | osid.authorization.Vault | the Vault associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForFunctionNotifications | ||
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 | useFederatedVaultView | ||
Description |
Federates the view for methods in this session. A federated view will include functions in vaults which are children of this vault in the vault hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedVaultView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this vault only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableFunctionNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableFunctionNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeFunctionNotification | ||
Description |
Acknowledge a function notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewFunctions | ||
Description |
Register for notifications of new functions. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedFunctions | ||
Description |
Registers for notification of updated functions. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedFunction | ||
Description |
Registers for notification of an updated function.
| ||
Parameters | osid.id.Id | functionId | the Id of the Function to monitor |
Errors | NULL_ARGUMENT | functionId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedFunctions | ||
Description |
Registers for notification of deleted functions. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedFunction | ||
Description |
Registers for notification of a deleted function.
| ||
Parameters | osid.id.Id | functionId | the Id of the Function to monitor |
Errors | NULL_ARGUMENT | functionId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |