public interface PlanNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Plan
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.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgePlanNotification(Id notificationId)
Acknowledge a plan notification.
|
boolean |
canRegisterForPlanNotifications()
Tests if this user can register for
Plan notifications. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
void |
registerForChangedPlan(Id planId)
Registers for notification of an updated plan.
|
void |
registerForChangedPlans()
Registers for notification of updated plans.
|
void |
registerForChangedPlansForCourseOffering(Id courseOfferingId)
Registers for notification of updated plans for the given course
offering.
|
void |
registerForChangedPlansForSyllabus(Id syllabusId)
Registers for notification of updated plans for the given syllabus.
|
void |
registerForDeletedPlan(Id planId)
Registers for notification of a deleted plan.
|
void |
registerForDeletedPlans()
Registers for notification of deleted plans.
|
void |
registerForDeletedPlansForCourseOffering(Id courseOfferingId)
Registers for notification of deleted plans for the given course
offering.
|
void |
registerForDeletedPlansForSyllabus(Id syllabusId)
Registers for notification of deleted plans for the given syllabus.
|
void |
registerForNewPlans()
Register for notifications of new plans.
|
void |
registerForNewPlansForCourseOffering(Id courseOfferingId)
Register for notifications of new plans for the given course offering.
|
void |
registerForNewPlansForSyllabus(Id syllabusId)
Register for notifications of new plans for the given syllabus.
|
void |
reliablePlanNotifications()
Reliable notifications are desired.
|
void |
unreliablePlanNotifications()
Unreliable notifications are desired.
|
void |
useFederatedCourseCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCourseCatalogView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCourseCatalogId()
CourseCatalog
Id
associated
with this session. CourseCatalog Id
associated with this
sessionmandatory
- This method must be implemented. CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
CourseCatalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForPlanNotifications()
Plan
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedCourseCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCourseCatalogView()
mandatory
- This method is must be implemented. void reliablePlanNotifications()
acknowledgePlanNotification()
.mandatory
- This method is must be implemented. void unreliablePlanNotifications()
mandatory
- This method is must be implemented. void acknowledgePlanNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewPlans() throws OperationFailedException, PermissionDeniedException
PlanReceiver.newPlans()
is invoked when a new Plan
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewPlansForSyllabus(Id syllabusId) throws OperationFailedException, PermissionDeniedException
PlanReceiver.newPlans()
is invoked when a new Plan
is created.syllabusId
- the Id
of the Syllabus
to monitorNullArgumentException
- syllabusId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewPlansForCourseOffering(Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
PlanReceiver.newPlans()
is invoked when a new
Plan
is created.courseOfferingId
- the Id
of the
CourseOffering
to monitorNullArgumentException
- courseOfferingId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPlans() throws OperationFailedException, PermissionDeniedException
PlanReceiver.changedPlans()
is invoked when a plan is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPlansForSyllabus(Id syllabusId) throws OperationFailedException, PermissionDeniedException
PlanReceiver.changedPlans()
is invoked when a plan is
changed.syllabusId
- the Id
of the Syllabus
to monitorNullArgumentException
- syllabusId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPlansForCourseOffering(Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
PlanReceiver.changedPlans()
is invoked when a
plan is changed.courseOfferingId
- the Id
of the
CourseOffering
to monitorNullArgumentException
- courseOfferingId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPlan(Id planId) throws OperationFailedException, PermissionDeniedException
PlanReceiver.changedPlans()
is invoked when the specified plan
is changed.planId
- the Id
of the Plan
to
monitorNullArgumentException
- planId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPlans() throws OperationFailedException, PermissionDeniedException
PlanReceiver.deletedPlans()
is invoked when a plan in this
catalog is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPlansForSyllabus(Id syllabusId) throws OperationFailedException, PermissionDeniedException
PlanReceiver.deletedPlans()
is invoked when a plan in
this catalog is deleted.syllabusId
- the Id
of the Syllabus
to monitorNullArgumentException
- syllabusId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPlansForCourseOffering(Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
PlanReceiver.deletedPlans()
is invoked when a
plan in this catalog is deleted.courseOfferingId
- the Id
of the
CourseOffering
to monitorNullArgumentException
- courseOfferingId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPlan(Id planId) throws OperationFailedException, PermissionDeniedException
PlanReceiver.deletedPlans()
is invoked when the specified plan
in this catalog is deleted.planId
- the Id
of the Plan
to
monitorNullArgumentException
- planId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.