OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.AgendaNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Agenda objects in this Engine. This also includes existing agendas that may appear or disappear due to changes in the Engine hierarchy, 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 AgendaLookupSession.

MethodgetEngineId
Description

Gets the Engine Id associated with this session.

Returnosid.id.Idthe Engine Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetEngine
Description

Gets the Engine associated with this session.

Returnosid.rules.Enginethe engine
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForAgendaNotifications
Description

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

Federates the view for methods in this session. A federated view will include agendas in engines which are children of this engine in the engine hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedEngineView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewAgendas
Description

Register for notifications of new agendas. AgendaReceiver.newAgendas() is invoked when a new Agenda appears in this engine.

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

Registers for notification of updated agendas. AgendaReceiver.changedAgendas() is invoked when an agenda in this engine is changed.

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

Registers for notification of an updated agenda. AgendaReceiver.changedAgendas() is invoked when the specified agenda in this engine is changed.

Parametersosid.id.IdagendaIdthe Id of the Agenda to monitor
ErrorsNOT_FOUNDan agenda was not found in this engine identified by the given Id
NULL_ARGUMENT agendaId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAgendas
Description

Registers for notification of deleted agendas. AgendaReceiver.deletedAgendas() is invoked when an agenda is deleted or removed from this engine.

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

Registers for notification of a deleted agenda. AgendaReceiver.deletedAgendas() is invoked when the specified agenda is deleted or removed from this engine.

Parametersosid.id.IdagendaIdthe Id of the Agenda to monitor
ErrorsNOT_FOUNDan agenda was not found identified by the given Id
NULL_ARGUMENT agendaId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.