OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ObjectiveNotificationSession
Implementsosid.OsidSession
Description

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

The views defined in this session correspond to the views in the ObjectiveLookupSession.

MethodgetObjectiveBankId
Description

Gets the ObjectiveBank Id associated with this session.

Returnosid.id.Idthe ObjectiveBank Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveBank
Description

Gets the ObjectiveBank associated with this session.

Returnosid.learning.ObjectiveBankthe ObjectiveBank associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForObjectiveNotifications
Description

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

Federates the view for methods in this session. A federated view will include notifications for objectives in objective banks which are children of this objective bank in the objective bank hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedObjectiveBankView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodreliableObjectiveNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableObjectiveNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeObjectiveNotification
Description

Acknowledge an objective notification.

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

Register for notifications of new objectives. ObjectiveReceiver.newObjectives() is invoked when a new objective is created.

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

Registers for notification of updated objectives. ObjectiveReceiver.changedObjectives() is invoked when an objective is changed.

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

Registers for notification of an updated objective. ObjectiveReceiver.changedObjectives() is invoked when the specified objective is changed.

Parametersosid.id.IdobjectiveIdthe Id of the Objective to monitor
ErrorsNULL_ARGUMENT objectiveId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedObjectives
Description

Registers for notification of deleted objectives. ObjectiveReceiver.deletedObjectives() is invoked when an objective is removed from this objective bank.

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

Registers for notification of a deleted objective. ObjectiveReceiver.changedObjectives() is invoked when the specified objective is removed from this objective bank.

Parametersosid.id.IdobjectiveIdthe Id of the Objective to monitor
ErrorsNULL_ARGUMENT objectiveid is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedObjectiveHierarchy
Description

Registers for notification of an updated objective hierarchy structure. ObjectiveReceiver.changedChildOfObjectives() is invoked when a node experiences a change in its children.

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

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

Parametersosid.id.IdobjectiveIdthe Id of the Objective node to monitor
ErrorsNULL_ARGUMENT objectiveId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedObjectiveHierarchyForDescendants
Description

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

Parametersosid.id.IdobjectiveIdthe Id of the Objective node to monitor
ErrorsNULL_ARGUMENT objectiveId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.