OSID Logo
OSID Specifications
sequencing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.sequencing.ChainNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Chain objects in this dDstributor. 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.

The two views defined in this session correspond to the views in the ChainLookupSession.

MethodgetAntimatroidId
Description

Gets the Antimatroid Id associated with this session.

Returnosid.id.Idthe Antimatroid Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAntimatroid
Description

Gets the Antimatroid associated with this session.

Returnosid.sequencing.Antimatroidthe antimatroid
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForChainNotifications
Description

Tests if this user can register for Chain notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer notification operations.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedAntimatroidView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedAntimatroidView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this antimatroid only.

CompliancemandatoryThis method is must be implemented.
MethodreliableChainNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeChainNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableChainNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeChainNotification
Description

Acknowledge a chain notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewChains
Description

Register for notifications of new chains. ChainReceiver.newChains() is invoked when a new Chain appears in this antimatroid.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedChains
Description

Registers for notification of updated chains. ChainReceiver.changedChains() is invoked when a chain in this antimatroid is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedChain
Description

Registers for notification of an updated chain. ChainReceiver.changedChains() is invoked when the specified chain in this antimatroid is changed.

Parametersosid.id.IdchainIdthe Id of the Chain to monitor
ErrorsNULL_ARGUMENT chainId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedChains
Description

Registers for notification of deleted chains. ChainReceiver.deletedChains() is invoked when a chain is deleted or removed from this antimatroid.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedChain
Description

Registers for notification of a deleted chain. ChainReceiver.deletedChains() is invoked when the specified chain is deleted or removed from this antimatroid.

Parametersosid.id.IdchainIdthe Id of the Chain to monitor
ErrorsNULL_ARGUMENT chainId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.