OSID Logo
OSID Specifications
course plan package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.plan.CoursePlanProxyManager
Implementsosid.OsidProxyManager
osid.course.plan.CoursePlanProfile
Description

The course plan manager provides access to planning sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy for passing information from a server environment. 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.

MethodgetPlanLookupSession
Description

Gets the OsidSession associated with the plan lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.course.plan.PlanLookupSessiona PlanLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPlanLookup() is false
ComplianceoptionalThis method must be implemented if supportsPlanLookup() is true.
MethodgetPlanLookupSessionForCourseCatalog
Description

Gets the OsidSession associated with the plan lookup service for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
osid.proxy.Proxyproxya proxy
Returnosid.course.plan.PlanLookupSessiona PlanLookupSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPlanLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPlanLookup() and supportsVisibleFederation() are true
MethodgetPlanQuerySession
Description

Gets the OsidSession associated with the plan query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.course.plan.PlanQuerySessiona PlanQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPlanQuery() is false
ComplianceoptionalThis method must be implemented if supportsPlanQuery() is true.
MethodgetPlanQuerySessionForCourseCatalog
Description

Gets the OsidSession associated with the plan query service for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
osid.proxy.Proxyproxya proxy
Returnosid.course.plan.PlanQuerySessiona PlanQuerySession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPlanQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPlanQuery() and supportsVisibleFederation() are true
MethodgetPlanSearchSession
Description

Gets the OsidSession associated with the plan search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.course.plan.PlanSearchSessiona PlanSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPlanSearch() is false
ComplianceoptionalThis method must be implemented if supportsPlanSearch() is true.
MethodgetPlanSearchSessionForCourseCatalog
Description

Gets the OsidSession associated with the plan search service for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
osid.proxy.Proxyproxya proxy
Returnosid.course.plan.PlanSearchSessiona PlanSearchSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPlanSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPlanSearch() and supportsVisibleFederation() are true
MethodgetPlanAdminSession
Description

Gets the OsidSession associated with the plan administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.course.plan.PlanAdminSessiona PlanAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPlanAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPlanAdmin() is true.
MethodgetPlanAdminSessionForCourseCatalog
Description

Gets the OsidSession associated with the plan administration service for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
osid.proxy.Proxyproxya proxy
Returnosid.course.plan.PlanAdminSessiona PlanAdminSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPlanAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPlanAdmin() and supportsVisibleFederation() are true
MethodgetPlanNotificationSession
Description

Gets the OsidSession associated with the plan notification service.

Parametersosid.course.plan.PlanReceiverplanReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.course.plan.PlanNotificationSessiona PlanNotificationSession
ErrorsNULL_ARGUMENT planReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPlanNotification() is false
ComplianceoptionalThis method must be implemented if supportsPlanNotification() is true.
MethodgetPlanNotificationSessionForCourseCatalog
Description

Gets the OsidSession associated with the plan notification service for the given course catalog.

Parametersosid.course.plan.PlanReceiverplanReceiverthe receiver
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
osid.proxy.Proxyproxya proxy
Returnosid.course.plan.PlanNotificationSessiona PlanNotificationSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT planReceiver, courseCatalogId, or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPlanNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPlanNotification() and supportsVisibleFederation() are true
MethodgetPlanCourseCatalogSession
Description

Gets the session for retrieving plan to course catalog mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.course.plan.PlanCourseCatalogSessiona PlanCourseCatalogSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPlanCourseCatalog() is false
ComplianceoptionalThis method must be implemented if supportsPlanCourseCatalog() is true.
MethodgetPlanCourseCatalogAssignmentSession
Description

Gets the session for assigning plan to course catalog mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.course.plan.PlanCourseCatalogAssignmentSessiona PlanCourseCatalogAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPlanCourseCatalogAssignment() is false
ComplianceoptionalThis method must be implemented if supportsPlanCourseCatalogAssignment() is true.
MethodgetPlanSmartCourseCatalogSession
Description

Gets the session associated with the plan smart course catalog for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of the course catalog
osid.proxy.Proxyproxya proxy
Returnosid.course.plan.PlanSmartCourseCatalogSessiona PlanSmartCourseCatalogSession
ErrorsNOT_FOUND courseCatalogId not found
NULL_ARGUMENT courseCatalogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPlanSmartCourseCatalog() is false
ComplianceoptionalThis method must be implemented if supportsPlanSmartCourseCatalog() is true.
MethodgetLessonLookupSession
Description

Gets the OsidSession associated with the lesson lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.course.plan.LessonLookupSessiona LessonLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLessonLookup() is false
ComplianceoptionalThis method must be implemented if supportsLessonLookup() is true.
MethodgetLessonLookupSessionForCourseCatalog
Description

Gets the OsidSession associated with the lesson lookup service for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
osid.proxy.Proxyproxya proxy
Returnosid.course.plan.LessonLookupSessiona LessonLookupSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLessonLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLessonLookup() and supportsVisibleFederation() are true
MethodgetLessonQuerySession
Description

Gets the OsidSession associated with the lesson query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.course.plan.LessonQuerySessiona LessonQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLessonQuery() is false
ComplianceoptionalThis method must be implemented if supportsLessonQuery() is true.
MethodgetLessonQuerySessionForCourseCatalog
Description

Gets the OsidSession associated with the lesson query service for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
osid.proxy.Proxyproxya proxy
Returnosid.course.plan.LessonQuerySessiona LessonQuerySession
ErrorsNOT_FOUNDno Lesson found by the given Id
NULL_ARGUMENT courseCatalogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLessonQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLessonQuery() and supportsVisibleFederation() are true
MethodgetLessonSearchSession
Description

Gets the OsidSession associated with the lesson search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.course.plan.LessonSearchSessiona LessonSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLessonSearch() is false
ComplianceoptionalThis method must be implemented if supportsLessonSearch() is true.
MethodgetLessonSearchSessionForCourseCatalog
Description

Gets the OsidSession associated with the lesson search service for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
osid.proxy.Proxyproxya proxy
Returnosid.course.plan.LessonSearchSessiona LessonSearchSession
ErrorsNOT_FOUNDno Lesson found by the given Id
NULL_ARGUMENT courseCatalogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLessonSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLessonSearch() and supportsVisibleFederation() are true
MethodgetLessonAdminSession
Description

Gets the OsidSession associated with the lesson administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.course.plan.LessonAdminSessiona LessonAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLessonAdmin() is false
ComplianceoptionalThis method must be implemented if supportsLessonAdmin() is true.
MethodgetLessonAdminSessionForCourseCatalog
Description

Gets the OsidSession associated with the lesson administration service for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
osid.proxy.Proxyproxya proxy
Returnosid.course.plan.LessonAdminSessiona LessonAdminSession
ErrorsNOT_FOUNDno Lesson found by the given Id
NULL_ARGUMENT courseCatalogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLessonAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLessonAdmin() and supportsVisibleFederation() are true
MethodgetLessonNotificationSession
Description

Gets the OsidSession associated with the lesson notification service.

Parametersosid.course.plan.LessonReceiverlessonReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.course.plan.LessonNotificationSessiona LessonNotificationSession
ErrorsNULL_ARGUMENT lessonReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLessonNotification() is false
ComplianceoptionalThis method must be implemented if supportsLessonNotification() is true.
MethodgetLessonNotificationSessionForCourseCatalog
Description

Gets the OsidSession associated with the lesson notification service for the given course catalog.

Parametersosid.course.plan.LessonReceiverlessonReceiverthe receiver
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
osid.proxy.Proxyproxya proxy
Returnosid.course.plan.LessonNotificationSessiona LessonNotificationSession
ErrorsNOT_FOUNDno Lesson found by the given Id
NULL_ARGUMENT lessonReceiver, courseCatalogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLessonNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLessonNotification() and supportsVisibleFederation() are true
MethodgetLessonCourseCatalogSession
Description

Gets the session for retrieving lesson to course catalog mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.course.plan.LessonCourseCatalogSessiona LessonCourseCatalogSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLessonCourseCatalog() is false
ComplianceoptionalThis method must be implemented if supportsLessonCourseCatalog() is true.
MethodgetLessonCourseCatalogAssignmentSession
Description

Gets the session for assigning lesson to course catalog mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.course.plan.LessonCourseCatalogAssignmentSessiona LessonCourseCatalogAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLessonCourseCatalogAssignment() is false
ComplianceoptionalThis method must be implemented if supportsLessonCourseCatalogAssignment() is true.
MethodgetLessonSmartCourseCatalogSession
Description

Gets the session for managing dynamic lesson course catalogs for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of a course catalog
osid.proxy.Proxyproxya proxy
Returnosid.course.plan.LessonSmartCourseCatalogSessiona LessonSmartCourseCatalogSession
ErrorsNOT_FOUND courseCatalogId is not found
NULL_ARGUMENT courseCatalogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLessonSmartCourseCatalog() is false
ComplianceoptionalThis method must be implemented if supportsLessonSmartCourseCatalog() is true.
MethodgetLessonConflictSession
Description

Gets the OsidSession associated with the lesson conflict service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.course.plan.LessonConflictSessiona LessonConflictSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLessonConflict() is false
ComplianceoptionalThis method must be implemented if supportsLessonConflict() is true.
MethodgetLessonConflictSessionForCourseCatalog
Description

Gets the OsidSession associated with the lesson conflict service for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of the course catalog
osid.proxy.Proxyproxya proxy
Returnosid.course.plan.LessonConflictSessiona LessonConflictSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLessonConflict() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLessonConflict() and supportsVisibleFederation() are true
MethodgetLessonAnchoringSession
Description

Gets the OsidSession associated with the lesson conflict service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.course.plan.LessonConflictSessiona LessonConflictSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLessonConflict() is false
ComplianceoptionalThis method must be implemented if supportsLessonConflict() is true.
MethodgetLessonAnchoringSessionForCourseCatalog
Description

Gets the OsidSession associated with the lesson anchoring service for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of the course catalog
osid.proxy.Proxyproxya proxy
Returnosid.course.plan.LessonConflictSessiona LessonAnchoringSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLessonAnchoring() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLessonAnchoring() and supportsVisibleFederation() are true