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

This session defines methods to receive asynchronous notifications on adds/changes to Activity 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 two views defined in this session correspond to the views in the ActivityLookupSession.

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.
MethodcanRegisterForActivityNotifications
Description

Tests if this user can register for Activity 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 activities 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.
MethodreliableActivityNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableActivityNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeActivityNotification
Description

Acknowledge an activity notification.

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

Register for notifications of new activities. ActivityReceiver.newActivities() is invoked when a new activity is created.

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

Register for notifications of new activities for the given objective. ActivityReceiver.newActivities() is invoked when a new activity is created.

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

Registers for notification of updated activities. ActivityReceiver.changedActivities() is invoked when an activity is changed.

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

Registers for notification of updated activities. ActivityReceiver.changedActivities() is invoked when an activity 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.
MethodregisterForChangedActivity
Description

Registers for notification of an updated activity. ActivityReceiver.changedActivities() is invoked when the specified activity is changed.

Parametersosid.id.IdactivityIdthe Id of the Activity to monitor
ErrorsNULL_ARGUMENT activityId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedActivities
Description

Registers for notification of deleted activities. ActivityReceiver.deletedActivities() is invoked when an activity is removed from this objective bank.

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

Registers for notification of deleted activities. ActivityReceiver.deletedActivities() is invoked when an activity 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.
MethodregisterForDeletedActivity
Description

Registers for notification of a deleted activity. ActivityReceiver.changedActivities() is invoked when the specified activity is removed from this objective bank.

Parametersosid.id.IdactivityIdthe Id of the Activity to monitor
ErrorsNULL_ARGUMENT activityId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.