OSID - osid.course.plan.PlanNotificationSession Service Interface Definition

Interface	osid.course.plan.PlanNotificationSession
Implements	`osid.OsidSession`
Description	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.
Method	getCourseCatalogId
Description	Gets the `CourseCatalog` `Id` associated with this session.
Return	`osid.id.Id`		the `CourseCatalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalog
Description	Gets the `CourseCatalog` associated with this session.
Return	`osid.course.CourseCatalog`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForPlanNotifications
Description	Tests if this user can register for `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.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedCourseCatalogView
Description	Federates the view for methods in this session. A federated view will include plans in course catalogs which are children of this course catalog in the course catalog hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCourseCatalogView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliablePlanNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgePlanNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliablePlanNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgePlanNotification
Description	Acknowledge a plan notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewPlans
Description	Register for notifications of new plans. `PlanReceiver.newPlans()` is invoked when a new `Plan` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewPlansForSyllabus
Description	Register for notifications of new plans for the given syllabus. `PlanReceiver.newPlans()` is invoked when a new `Plan` is created.
Parameters	`osid.id.Id`	`syllabusId`	the `Id` of the `Syllabus` to monitor
Errors	NULL_ARGUMENT		`syllabusId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewPlansForCourseOffering
Description	Register for notifications of new plans for the given course offering. `PlanReceiver.newPlans()` is invoked when a new `Plan` is created.
Parameters	`osid.id.Id`	`courseOfferingId`	the `Id` of the `CourseOffering` to monitor
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPlans
Description	Registers for notification of updated plans. `PlanReceiver.changedPlans()` is invoked when a plan is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPlansForSyllabus
Description	Registers for notification of updated plans for the given syllabus. `PlanReceiver.changedPlans()` is invoked when a plan is changed.
Parameters	`osid.id.Id`	`syllabusId`	the `Id` of the `Syllabus` to monitor
Errors	NULL_ARGUMENT		`syllabusId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPlansForCourseOffering
Description	Registers for notification of updated plans for the given course offering. `PlanReceiver.changedPlans()` is invoked when a plan is changed.
Parameters	`osid.id.Id`	`courseOfferingId`	the `Id` of the `CourseOffering` to monitor
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPlan
Description	Registers for notification of an updated plan. `PlanReceiver.changedPlans()` is invoked when the specified plan is changed.
Parameters	`osid.id.Id`	`planId`	the `Id` of the `Plan` to monitor
Errors	NULL_ARGUMENT		`planId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPlans
Description	Registers for notification of deleted plans. `PlanReceiver.deletedPlans()` is invoked when a plan in this catalog is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPlansForSyllabus
Description	Registers for notification of deleted plans for the given syllabus. `PlanReceiver.deletedPlans()` is invoked when a plan in this catalog is deleted.
Parameters	`osid.id.Id`	`syllabusId`	the `Id` of the `Syllabus` to monitor
Errors	NULL_ARGUMENT		`syllabusId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPlansForCourseOffering
Description	Registers for notification of deleted plans for the given course offering. `PlanReceiver.deletedPlans()` is invoked when a plan in this catalog is deleted.
Parameters	`osid.id.Id`	`courseOfferingId`	the `Id` of the `CourseOffering` to monitor
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPlan
Description	Registers for notification of a deleted plan. `PlanReceiver.deletedPlans()` is invoked when the specified plan in this catalog is deleted.
Parameters	`osid.id.Id`	`planId`	the `Id` of the `Plan` to monitor
Errors	NULL_ARGUMENT		`planId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.