Interface | osid.authorization.QualifierNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive 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 | canRegisterForQualifierNotifications | ||
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 notifications for qualifiers 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 qualifiers to this vault only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableQualifierNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableQualifierNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeQualifierNotification | ||
Description |
Acknowledge a qualifier 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 | registerForNewQualifiers | ||
Description |
Register for notifications of new qualifiers. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedQualifiers | ||
Description |
Registers for notification of updated qualifiers.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedQualifier | ||
Description |
Registers for notification of an updated qualifier.
| ||
Parameters | osid.id.Id | qualifierId | the Id of the Qualifier to monitor |
Errors | NULL_ARGUMENT | qualifierId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedQualifiers | ||
Description |
Registers for notification of deleted qualifiers.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedQualifier | ||
Description |
Registers for notification of a deleted qualifier.
| ||
Parameters | osid.id.Id | qualifierId | the Id of the Qualifier to monitor |
Errors | NULL_ARGUMENT | qualifierId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedQualifierHierarchy | ||
Description |
Registers for notification of an updated qualifier
hierarchy structure. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedQualifierHierarchyForAncestors | ||
Description |
Registers for notification of an updated qualifier
hierarchy structure. | ||
Parameters | osid.id.Id | qualifierId | the Id of the Qualifier node to monitor |
Errors | NULL_ARGUMENT | qualifierId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedQualifierHierarchyForDescendants | ||
Description |
Registers for notification of an updated qualifier
hierarchy structure. | ||
Parameters | osid.id.Id | qualifierId | the Id of the Qualifier node to monitor |
Errors | NULL_ARGUMENT | qualifierId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |