Interface | osid.course.plan.CoursePlanManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.course.plan.CoursePlanProfile | |||
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:
The course plan manager also provides a profile for determing the supported search types supported by this service. | ||
Method | getPlanLookupSession | ||
Description |
Gets the | ||
Return | osid.course.plan.PlanLookupSession | a PlanLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsPlanLookup() is false | ||
Compliance | optional | This method must be implemented if supportsPlanLookup() is
true. | |
Method | getPlanLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
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 | ||
Return | osid.course.plan.PlanQuerySession | a PlanQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsPlanQuery() is false | ||
Compliance | optional | This method must be implemented if supportsPlanQuery() is
true. | |
Method | getPlanQuerySessionForCourseCatalog | ||
Description |
Gets the | ||
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 | ||
Return | osid.course.plan.PlanSearchSession | a PlanSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsPlanSearch() is false | ||
Compliance | optional | This method must be implemented if supportsPlanSearch() is
true. | |
Method | getPlanSearchSessionForCourseCatalog | ||
Description |
Gets the | ||
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 | ||
Return | osid.course.plan.PlanAdminSession | a PlanAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsPlanAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsPlanAdmin() is
true. | |
Method | getPlanAdminSessionForCourseCatalog | ||
Description |
Gets the | ||
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 | ||
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 | ||
Parameters | osid.course.plan.PlanReceiver | planReceiver | the receiver |
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 | |
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 | |
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 | ||
Return | osid.course.plan.LessonLookupSession | a LessonLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsLessonLookup() is false | ||
Compliance | optional | This method must be implemented if supportsLessonLookup() is
true. | |
Method | getLessonLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
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 | ||
Return | osid.course.plan.LessonQuerySession | a LessonQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsLessonQuery() is false | ||
Compliance | optional | This method must be implemented if supportsLessonQuery() is
true. | |
Method | getLessonQuerySessionForCourseCatalog | ||
Description |
Gets the | ||
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 | ||
Return | osid.course.plan.LessonSearchSession | a LessonSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsLessonSearch() is false | ||
Compliance | optional | This method must be implemented if supportsLessonSearch() is
true. | |
Method | getLessonSearchSessionForCourseCatalog | ||
Description |
Gets the | ||
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 | ||
Return | osid.course.plan.LessonAdminSession | a LessonAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsLessonAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsLessonAdmin() is
true. | |
Method | getLessonAdminSessionForCourseCatalog | ||
Description |
Gets the | ||
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 | ||
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 | ||
Parameters | osid.course.plan.LessonReceiver | lessonReceiver | the receiver |
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 | |
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 | |
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 | ||
Return | osid.course.plan.LessonConflictSession | a LessonConflictSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsLessonConflict() is false | ||
Compliance | optional | This method must be implemented if supportsLessonConflict()
is true. | |
Method | getLessonConflictSessionForCourseCatalog | ||
Description |
Gets the | ||
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 | ||
Return | osid.course.plan.LessonConflictSession | a LessonConflictSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsLessonConflict() is false | ||
Compliance | optional | This method must be implemented if supportsLessonConflict()
is true. | |
Method | getLessonAnchoringSessionForCourseCatalog | ||
Description |
Gets the | ||
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 |