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

Interface	osid.course.plan.CoursePlanManager
Implements	`osid.OsidManager`
Implements	`osid.course.plan.CoursePlanProfile`
Used By	`osid.course.CourseManager`
Description	The course plan manager provides access to course planning sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `PlanLookupSession` : a session to lookup plans `PlanQuerySession` : a session to query plans `PlanSearchSession` : a session to search plans `PlanAdminSession` : a session to manage plans `PlanNotificationSession` : a session to subscribe to notifications of plan changes `PlanCourseCatalogSession` : a session to lookup plan course catalog mappings `PlanCourseCatalogAssignmentSession` : a session to manage plan course catalog mappings `PlanSmartCourseCatalogSession` : a session to manage smart course catalogs of plans `LessonLookupSession` : a session to retrieve lessons `LessonQuerySession` : a session to query lessons `LessonSearchSession` : a session to search for lessons `LessonAdminSession` : a session to create, update and delete lessons `LessonNotificationSession` : a session to receive notifications for changes in lessons `LessonCourseCatalogSession` : a session to lookup lesson course catalog mappings `LessonCourseCatalogAssignmentSession` : a session to manage lesson course catalog mappings `LessonSmartCourseCatalogSession` : a session to manage smart course catalogs of lessons `LessonConflictSession` : a session to examine gaps and overlapps in lessons `LessonAnchoringSession` : a session to anchor lessons to specific activities and times The course plan manager also provides a profile for determing the supported search types supported by this service.
Method	getPlanLookupSession
Description	Gets the `OsidSession` associated with the plan lookup service.
Return	`osid.course.plan.PlanLookupSession`		a `PlanLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPlanLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPlanLookup()` is `true` .
Method	getPlanLookupSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the plan lookup service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.plan.PlanLookupSession`		a `PlanLookupSession`
Errors	NOT_FOUND		no `CourseCatalog` found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPlanLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPlanLookup()` and `supportsVisibleFederation()` are `true`
Method	getPlanQuerySession
Description	Gets the `OsidSession` associated with the plan query service.
Return	`osid.course.plan.PlanQuerySession`		a `PlanQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPlanQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPlanQuery()` is `true` .
Method	getPlanQuerySessionForCourseCatalog
Description	Gets the `OsidSession` associated with the plan query service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.plan.PlanQuerySession`		a `PlanQuerySession`
Errors	NOT_FOUND		no `CourseCatalog` found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPlanQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPlanQuery()` and `supportsVisibleFederation()` are `true`
Method	getPlanSearchSession
Description	Gets the `OsidSession` associated with the plan search service.
Return	`osid.course.plan.PlanSearchSession`		a `PlanSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPlanSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPlanSearch()` is `true` .
Method	getPlanSearchSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the plan search service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.plan.PlanSearchSession`		a `PlanSearchSession`
Errors	NOT_FOUND		no `CourseCatalog` found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPlanSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPlanSearch()` and `supportsVisibleFederation()` are `true`
Method	getPlanAdminSession
Description	Gets the `OsidSession` associated with the plan administration service.
Return	`osid.course.plan.PlanAdminSession`		a `PlanAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPlanAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPlanAdmin()` is `true` .
Method	getPlanAdminSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the plan administration service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.plan.PlanAdminSession`		a `PlanAdminSession`
Errors	NOT_FOUND		no `CourseCatalog` found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPlanAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPlanAdmin()` and `supportsVisibleFederation()` are `true`
Method	getPlanNotificationSession
Description	Gets the `OsidSession` associated with the plan notification service.
Parameters	`osid.course.plan.PlanReceiver`	`planReceiver`	the receiver
Return	`osid.course.plan.PlanNotificationSession`		a `PlanNotificationSession`
Errors	NULL_ARGUMENT		`planReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPlanNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPlanNotification()` is `true` .
Method	getPlanNotificationSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the plan notification service for the given course catalog.
Parameters	`osid.course.plan.PlanReceiver`	`planReceiver`	the receiver
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.plan.PlanNotificationSession`		a `PlanNotificationSession`
Errors	NOT_FOUND		no `CourseCatalog` found by the given `Id`
	NULL_ARGUMENT		`planReceiver` or `courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPlanNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPlanNotification()` and `supportsVisibleFederation()` are `true`
Method	getPlanCourseCatalogSession
Description	Gets the session for retrieving plan to course catalog mappings.
Return	`osid.course.plan.PlanCourseCatalogSession`		a `PlanCourseCatalogSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPlanCourseCatalog()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPlanCourseCatalog()` is `true` .
Method	getPlanCourseCatalogAssignmentSession
Description	Gets the session for assigning plan to course catalog mappings.
Return	`osid.course.plan.PlanCourseCatalogAssignmentSession`		a `PlanCourseCatalogAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPlanCourseCatalogAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPlanCourseCatalogAssignment()` is `true` .
Method	getPlanSmartCourseCatalogSession
Description	Gets the session associated with the plan smart course catalog for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the course catalog
Return	`osid.course.plan.PlanSmartCourseCatalogSession`		a `PlanSmartCourseCatalogSession`
Errors	NOT_FOUND		`courseCatalogId` not found
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPlanSmartCourseCatalog()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPlanSmartCourseCatalog()` is `true` .
Method	getLessonLookupSession
Description	Gets the `OsidSession` associated with the lesson lookup service.
Return	`osid.course.plan.LessonLookupSession`		a `LessonLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLessonLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLessonLookup()` is `true` .
Method	getLessonLookupSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the lesson lookup service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.plan.LessonLookupSession`		a `LessonLookupSession`
Errors	NOT_FOUND		no `CourseCatalog` found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLessonLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLessonLookup()` and `supportsVisibleFederation()` are `true`
Method	getLessonQuerySession
Description	Gets the `OsidSession` associated with the lesson query service.
Return	`osid.course.plan.LessonQuerySession`		a `LessonQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLessonQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLessonQuery()` is `true` .
Method	getLessonQuerySessionForCourseCatalog
Description	Gets the `OsidSession` associated with the lesson query service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.plan.LessonQuerySession`		a `LessonQuerySession`
Errors	NOT_FOUND		no `CourseCatalog` found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLessonQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLessonQuery()` and `supportsVisibleFederation()` are `true`
Method	getLessonSearchSession
Description	Gets the `OsidSession` associated with the lesson search service.
Return	`osid.course.plan.LessonSearchSession`		a `LessonSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLessonSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLessonSearch()` is `true` .
Method	getLessonSearchSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the lesson search service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.plan.LessonSearchSession`		a `LessonSearchSession`
Errors	NOT_FOUND		no `CourseCatalog` found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLessonSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLessonSearch()` and `supportsVisibleFederation()` are `true`
Method	getLessonAdminSession
Description	Gets the `OsidSession` associated with the lesson administrative service.
Return	`osid.course.plan.LessonAdminSession`		a `LessonAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLessonAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLessonAdmin()` is `true` .
Method	getLessonAdminSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the lesson administrative service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.plan.LessonAdminSession`		a `LessonAdminSession`
Errors	NOT_FOUND		no `CourseCatalog` found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLessonAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLessonAdmin()` and `supportsVisibleFederation()` are `true`
Method	getLessonNotificationSession
Description	Gets the `OsidSession` associated with the lesson notification service.
Parameters	`osid.course.plan.LessonReceiver`	`lessonReceiver`	the receiver
Return	`osid.course.plan.LessonNotificationSession`		a `LessonNotificationSession`
Errors	NULL_ARGUMENT		`lessonReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLessonNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLessonNotification()` is `true` .
Method	getLessonNotificationSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the lesson notification service for the given course catalog.
Parameters	`osid.course.plan.LessonReceiver`	`lessonReceiver`	the receiver
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `CourseCatalog`
Return	`osid.course.plan.LessonNotificationSession`		a `LessonNotificationSession`
Errors	NOT_FOUND		no `CourseCatalog` found by the given `Id`
	NULL_ARGUMENT		`lessonReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLessonNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLessonNotification()` and `supportsVisibleFederation()` are `true`
Method	getLessonCourseCatalogSession
Description	Gets the session for retrieving lesson to course catalog mappings.
Return	`osid.course.plan.LessonCourseCatalogSession`		a `LessonCourseCatalogSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLessonCourseCatalog()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLessonCourseCatalog()` is `true` .
Method	getLessonCourseCatalogAssignmentSession
Description	Gets the session for assigning lesson to course catalog mappings.
Return	`osid.course.plan.LessonCourseCatalogAssignmentSession`		a `LessonCourseCatalogAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLessonCourseCatalogAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLessonCourseCatalogAssignment()` is `true` .
Method	getLessonSmartCourseCatalogSession
Description	Gets the session associated with the lesson smart course catalog for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the course catalog
Return	`osid.course.plan.LessonSmartCourseCatalogSession`		a `LessonSmartCourseCatalogSession`
Errors	NOT_FOUND		`courseCatalogId` not found
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLessonSmartCourseCatalog()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLessonSmartCourseCatalog()` is `true` .
Method	getLessonConflictSession
Description	Gets the `OsidSession` associated with the lesson conflict service.
Return	`osid.course.plan.LessonConflictSession`		a `LessonConflictSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLessonConflict()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLessonConflict()` is `true` .
Method	getLessonConflictSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the lesson conflict service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `Lesson`
Return	`osid.course.plan.LessonConflictSession`		a `LessonConflictSession`
Errors	NOT_FOUND		no `CourseCatalog` found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLessonConflict()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLessonConflict()` and `supportsVisibleFederation()` are `true`
Method	getLessonAnchoringSession
Description	Gets the `OsidSession` associated with the lesson conflict service.
Return	`osid.course.plan.LessonConflictSession`		a `LessonConflictSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLessonConflict()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLessonConflict()` is `true` .
Method	getLessonAnchoringSessionForCourseCatalog
Description	Gets the `OsidSession` associated with the lesson anchoring service for the given course catalog.
Parameters	`osid.id.Id`	`courseCatalogId`	the `Id` of the `Lesson`
Return	`osid.course.plan.LessonConflictSession`		a `LessonAnchoringSession`
Errors	NOT_FOUND		no `CourseCatalog` found by the given `Id`
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLessonAnchoring()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLessonAnchoring()` and `supportsVisibleFederation()` are `true`