Interface | osid.authorization.AuthorizationNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive asynchronous
notifications on adds/changes to The 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 | canRegisterForAuthorizationNotifications | ||
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 authorizations 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 for authorizations in this vault only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableAuthorizationNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableAuthorizationNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeAuthorizationNotification | ||
Description |
Acknowledge an authorization 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 | useImplicitAuthorizationView | ||
Description |
Sets the view for methods in this session to implicit
authorizations. An implicit view will include
authorizations derived from other authorizations as a
result of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useExplicitAuthorizationView | ||
Description |
Sets the view for methods in this session to explicit
authorizations. An explicit view includes only those
authorizations that were explicitly defined and not
implied. This method is the opposite of | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewAuthorizations | ||
Description |
Register for notifications of new authorizations.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewAuthorizationsForResource | ||
Description |
Registers for notification of new authorizations for
the given resource including any authorizations related to
the resource through an agent. | ||
Parameters | osid.id.Id | resourceId | the Id of the Resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewAuthorizationsForFunction | ||
Description |
Register for notifications of new authorizations for
the given 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 | registerForChangedAuthorizations | ||
Description |
Registers for notification of updated authorizations.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAuthorizationsForResource | ||
Description |
Registers for notification of updated authorizations
for the given resource including any authorizations
related to the resource through an agent. | ||
Parameters | osid.id.Id | resourceId | the Id of the Resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedAuthorizationsForFunction | ||
Description |
Registers for notification of updated authorizations
for the given 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 | registerForChangedAuthorization | ||
Description |
Registers for notification of an updated authorization.
| ||
Parameters | osid.id.Id | authorizationId | the Id of the Authorization to monitor |
Errors | NULL_ARGUMENT | authorizationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedAuthorizations | ||
Description |
Registers for notification of deleted authorizations.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedAuthorizationsForResource | ||
Description |
Registers for notification of deleted authorizations
for the given resource including any authorizations
related to the resource through an agent. | ||
Parameters | osid.id.Id | resourceId | the Id of the Resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedAuthorizationsForFunction | ||
Description |
Registers for notification of deleted authorizations
for the given 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 | registerForDeletedAuthorization | ||
Description |
Registers for notification of a deleted authorization.
| ||
Parameters | osid.id.Id | authorizationId | the Id of the Authorization to monitor |
Errors | NULL_ARGUMENT | authorizationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |