Interface | osid.sequencing.ChainNotificationSession | ||
---|---|---|---|
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 | getAntimatroidId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Antimatroid Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getAntimatroid | ||
Description |
Gets the | ||
Return | osid.sequencing.Antimatroid | the antimatroid | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForChainNotifications | ||
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 | useFederatedAntimatroidView | ||
Description |
Federates the view for methods in this session. A federated view will include chains in antimatroids which are children of this antimatroid in the antimatroid hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedAntimatroidView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this antimatroid only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableChainNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableChainNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeChainNotification | ||
Description |
Acknowledge a chain 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 | registerForNewChains | ||
Description |
Register for notifications of new chains. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedChains | ||
Description |
Registers for notification of updated chains. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedChain | ||
Description |
Registers for notification of an updated chain. | ||
Parameters | osid.id.Id | chainId | the Id of the Chain to monitor |
Errors | NULL_ARGUMENT | chainId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedChains | ||
Description |
Registers for notification of deleted chains. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedChain | ||
Description |
Registers for notification of a deleted chain. | ||
Parameters | osid.id.Id | chainId | the Id of the Chain to monitor |
Errors | NULL_ARGUMENT | chainId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |