Interface | osid.learning.ObjectiveNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive asynchronous
notifications on adds/changes to The views defined in this session correspond to the views
in the | ||
Method | getObjectiveBankId | ||
Description |
Gets the | ||
Return | osid.id.Id | the ObjectiveBank Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getObjectiveBank | ||
Description |
Gets the | ||
Return | osid.learning.ObjectiveBank | the ObjectiveBank associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForObjectiveNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedObjectiveBankView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedObjectiveBankView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this objective bank only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableObjectiveNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableObjectiveNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeObjectiveNotification | ||
Description |
Acknowledge an objective notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewObjectives | ||
Description |
Register for notifications of new objectives. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedObjectives | ||
Description |
Registers for notification of updated objectives.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedObjective | ||
Description |
Registers for notification of an updated objective.
| ||
Parameters | osid.id.Id | objectiveId | the Id of the Objective to monitor |
Errors | NULL_ARGUMENT | objectiveId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedObjectives | ||
Description |
Registers for notification of deleted objectives.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedObjective | ||
Description |
Registers for notification of a deleted objective.
| ||
Parameters | osid.id.Id | objectiveId | the Id of the Objective to monitor |
Errors | NULL_ARGUMENT | objectiveid is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedObjectiveHierarchy | ||
Description |
Registers for notification of an updated objective
hierarchy structure. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedObjectiveHierarchyForAncestors | ||
Description |
Registers for notification of an updated objective
hierarchy structure. | ||
Parameters | osid.id.Id | objectiveId | the Id of the Objective node to monitor |
Errors | NULL_ARGUMENT | objectiveId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedObjectiveHierarchyForDescendants | ||
Description |
Registers for notification of an updated objective
hierarchy structure. | ||
Parameters | osid.id.Id | objectiveId | the Id of the Objective node to monitor |
Errors | NULL_ARGUMENT | objectiveId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |