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

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

MethodcanRegisterForAntimatroidNotifications
Description

Tests if this user can register for Antimatroid 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.
MethodreliableAntimatroidNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableAntimatroidNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeAntimatroidNotification
Description

Acknowledge an antimatroid notification.

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

Register for notifications of new antimatroids. AntimatroidReceiver.newAntimatroids() is invoked when a new Antimatroid is created.

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

Registers for notification of updated antimatroids. AntimatroidReceiver.changedAntimatroids() is invoked when an antimatroid is changed.

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

Registers for notification of an updated antimatroid. AntimatroidReceiver.changedAntimatroids() is invoked when the specified antimatroid is changed.

Parametersosid.id.IdantimatroidIdthe Id of the Antimatroid to monitor
ErrorsNULL_ARGUMENT antimatroidId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAntimatroids
Description

Registers for notification of deleted antimatroids. AntimatroidReceiver.deletedAntimatroids() is invoked when an antimatroid is deleted.

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

Registers for notification of a deleted antimatroid. AntimatroidReceiver.deletedAntimatroids() is invoked when the specified antimatroid is deleted.

Parametersosid.id.IdantimatroidIdthe Id of the Antimatroid to monitor
ErrorsNULL_ARGUMENT antimatroidId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAntimatroidHierarchy
Description

Registers for notification of an updated antimatroid hierarchy structure. AntimatroidReceiver.changedChildOfAntimatroids() is invoked when a node experiences a change in its children.

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

Registers for notification of an updated antimatroid hierarchy structure. AntimatroidReceiver.changedChildOfAntimatroids() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parametersosid.id.IdantimatroidIdthe Id of the Antimatroid node to monitor
ErrorsNULL_ARGUMENT antimatroidId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAntimatroidHierarchyForDescendants
Description

Registers for notification of an updated antimatroid hierarchy structure. AntimatroidReceiver.changedChildOfAntimatroids() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdantimatroidIdthe Id of the Antimatroid node to monitor
ErrorsNULL_ARGUMENT antimatroidId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.