OSID Logo
OSID Specifications
course syllabus package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.syllabus.CourseSyllabusManager
Implementsosid.OsidManager
osid.course.syllabus.CourseSyllabusProfile
Description

The course syllabus manager provides access to syllabus sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • SyllabusLookupSession: a session to lookup syllabi
  • SyllabusQuerySession: a session to query syllabi
  • SyllabusSearchSession: a session to search syllabi
  • SyllabusAdminSession: a session to manage syllabi
  • SyllabusNotificationSession: a session to subscribe to notifications of syllabus changes
  • SyllabusCourseCatalogSession: a session to lookup syllabus course catalog mappings
  • SyllabusCourseCatalogAssignmentSession: a session to manage syllabus course catalog mappings
  • SyllabusSmartCourseCatalogSession: a session to manage smart course catalogs of syllabi
  • ModuleSession : a session to get available modules for a resource
  • ModuleLookupSession: a session to lookup modules
  • ModuleQuerySession: a session to query modules
  • ModuleSearchSession: a session to search modules
  • ModuleAdminSession: a session to manage modules
  • ModuleNotificationSession: a session to subscribe to notifications of module changes
  • ModuleCourseCatalogSession: a session to lookup module course catalog mappings
  • ModuleCourseCatalogAssignmentSession: a session to manage module course catalog mappings
  • ModuleSmartCourseCatalogSession: a session to manage smart course catalogs of modules
  • DocetLookupSession: a session to retrieve docets
  • DocetQuerySession: a session to query docets
  • DocetSearchSession: a session to search for docets
  • DocetAdminSession: a session to create, update and delete docets
  • DocetNotificationSession: a session to receive notifications for changes in docets
  • DocetCourseCatalogSession: a session to lookup docet course catalog mappings
  • DocetCourseCatalogAssignmentSession: a session to manage docet course catalog mappings
  • DocetSmartCourseCatalogSession: a session to manage smart course catalogs of docets

The course manager also provides a profile for determing the supported search types supported by this service.

MethodgetSyllabusLookupSession
Description

Gets the OsidSession associated with the syllabus lookup service.

Returnosid.course.syllabus.SyllabusLookupSessiona SyllabusLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSyllabusLookup() is false
ComplianceoptionalThis method must be implemented if supportsSyllabusLookup() is true.
MethodgetSyllabusLookupSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.syllabus.SyllabusLookupSessiona SyllabusLookupSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSyllabusLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSyllabusLookup() and supportsVisibleFederation() are true
MethodgetSyllabusQuerySession
Description

Gets the OsidSession associated with the syllabus query service.

Returnosid.course.syllabus.SyllabusQuerySessiona SyllabusQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSyllabusQuery() is false
ComplianceoptionalThis method must be implemented if supportsSyllabusQuery() is true.
MethodgetSyllabusQuerySessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.syllabus.SyllabusQuerySessiona SyllabusQuerySession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSyllabusQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSyllabusQuery() and supportsVisibleFederation() are true
MethodgetSyllabusSearchSession
Description

Gets the OsidSession associated with the syllabus search service.

Returnosid.course.syllabus.SyllabusSearchSessiona SyllabusSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSyllabusSearch() is false
ComplianceoptionalThis method must be implemented if supportsSyllabusSearch() is true.
MethodgetSyllabusSearchSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.syllabus.SyllabusSearchSessiona SyllabusSearchSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSyllabusSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSyllabusSearch() and supportsVisibleFederation() are true
MethodgetSyllabusAdminSession
Description

Gets the OsidSession associated with the syllabus administration service.

Returnosid.course.syllabus.SyllabusAdminSessiona SyllabusAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSyllabusAdmin() is false
ComplianceoptionalThis method must be implemented if supportsSyllabusAdmin() is true.
MethodgetSyllabusAdminSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.syllabus.SyllabusAdminSessiona SyllabusAdminSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSyllabusAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSyllabusAdmin() and supportsVisibleFederation() are true
MethodgetSyllabusNotificationSession
Description

Gets the OsidSession associated with the syllabus notification service.

Parametersosid.course.syllabus.SyllabusReceiversyllabusReceiverthe receiver
Returnosid.course.syllabus.SyllabusNotificationSessiona SyllabusNotificationSession
ErrorsNULL_ARGUMENT syllabusReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSyllabusNotification() is false
ComplianceoptionalThis method must be implemented if supportsSyllabusNotification() is true.
MethodgetSyllabusNotificationSessionForCourseCatalog
Description

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

Parametersosid.course.syllabus.SyllabusReceiversyllabusReceiverthe receiver
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.syllabus.SyllabusNotificationSessiona SyllabusNotificationSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT syllabusReceiver or courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSyllabusNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSyllabusNotification() and supportsVisibleFederation() are true
MethodgetSyllabusCourseCatalogSession
Description

Gets the session for retrieving syllabus to course catalog mappings.

Returnosid.course.syllabus.SyllabusCourseCatalogSessiona SyllabusCourseCatalogSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSyllabusCourseCatalog() is false
ComplianceoptionalThis method must be implemented if supportsSyllabusCourseCatalog() is true.
MethodgetSyllabusCourseCatalogAssignmentSession
Description

Gets the session for assigning syllabus to course catalog mappings.

Returnosid.course.syllabus.SyllabusCourseCatalogAssignmentSessiona SyllabusCourseCatalogAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSyllabusCourseCatalogAssignment() is false
ComplianceoptionalThis method must be implemented if supportsSyllabusCourseCatalogAssignment() is true.
MethodgetSyllabusSmartCourseCatalogSession
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the course catalog
Returnosid.course.syllabus.SyllabusSmartCourseCatalogSessiona SyllabusSmartCourseCatalogSession
ErrorsNOT_FOUND courseCatalogId not found
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSyllabusSmartCourseCatalog() is false
ComplianceoptionalThis method must be implemented if supportsSyllabusSmartCourseCatalog() is true.
MethodgetModuleLookupSession
Description

Gets the OsidSession associated with the module lookup service.

Returnosid.course.syllabus.ModuleLookupSessiona ModuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsModuleLookup() is true.
MethodgetModuleLookupSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.syllabus.ModuleLookupSessiona ModuleLookupSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsModuleLookup() and supportsVisibleFederation() are true
MethodgetModuleQuerySession
Description

Gets the OsidSession associated with the module query service.

Returnosid.course.syllabus.ModuleQuerySessiona ModuleQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModuleQuery() is false
ComplianceoptionalThis method must be implemented if supportsModuleQuery() is true.
MethodgetModuleQuerySessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.syllabus.ModuleQuerySessiona ModuleQuerySession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModuleQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsModuleQuery() and supportsVisibleFederation() are true
MethodgetModuleSearchSession
Description

Gets the OsidSession associated with the module search service.

Returnosid.course.syllabus.ModuleSearchSessiona ModuleSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModuleSearch() is false
ComplianceoptionalThis method must be implemented if supportsModuleSearch() is true.
MethodgetModuleSearchSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.syllabus.ModuleSearchSessiona ModuleSearchSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModuleSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsModuleSearch() and supportsVisibleFederation() are true
MethodgetModuleAdminSession
Description

Gets the OsidSession associated with the module administration service.

Returnosid.course.syllabus.ModuleAdminSessiona ModuleAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModuleAdmin() is false
ComplianceoptionalThis method must be implemented if supportsModuleAdmin() is true.
MethodgetModuleAdminSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.syllabus.ModuleAdminSessiona ModuleAdminSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModuleAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsModuleAdmin() and supportsVisibleFederation() are true
MethodgetModuleNotificationSession
Description

Gets the OsidSession associated with the module notification service.

Parametersosid.course.syllabus.ModuleReceivermoduleReceiverthe receiver
Returnosid.course.syllabus.ModuleNotificationSessiona ModuleNotificationSession
ErrorsNULL_ARGUMENT moduleReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModuleNotification() is false
ComplianceoptionalThis method must be implemented if supportsModuleNotification() is true.
MethodgetModuleNotificationSessionForCourseCatalog
Description

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

Parametersosid.course.syllabus.ModuleReceivermoduleReceiverthe receiver
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.syllabus.ModuleNotificationSessiona ModuleNotificationSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT moduleReceiver or courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModuleNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsModuleNotification() and supportsVisibleFederation() are true
MethodgetModuleCourseCatalogSession
Description

Gets the session for retrieving module to course catalog mappings.

Returnosid.course.syllabus.ModuleCourseCatalogSessiona ModuleCourseCatalogSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModuleCourseCatalog() is false
ComplianceoptionalThis method must be implemented if supportsModuleCourseCatalog() is true.
MethodgetModuleCourseCatalogAssignmentSession
Description

Gets the session for assigning module to course catalog mappings.

Returnosid.course.syllabus.ModuleCourseCatalogAssignmentSessiona ModuleCourseCatalogAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModuleCourseCatalogAssignment() is false
ComplianceoptionalThis method must be implemented if supportsModuleCourseCatalogAssignment() is true.
MethodgetModuleSmartCourseCatalogSession
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the course catalog
Returnosid.course.syllabus.ModuleSmartCourseCatalogSessiona ModuleSmartCourseCatalogSession
ErrorsNOT_FOUND courseCatalogId not found
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModuleSmartCourseCatalog() is false
ComplianceoptionalThis method must be implemented if supportsModuleSmartCourseCatalog() is true.
MethodgetDocetLookupSession
Description

Gets the OsidSession associated with the docet lookup service.

Returnosid.course.syllabus.DocetLookupSessiona DocetLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDocetLookup() is false
ComplianceoptionalThis method must be implemented if supportsDocetLookup() is true.
MethodgetDocetLookupSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the Docet
Returnosid.course.syllabus.DocetLookupSessiona DocetLookupSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDocetLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDocetLookup() and supportsVisibleFederation() are true
MethodgetDocetQuerySession
Description

Gets the OsidSession associated with the docet query service.

Returnosid.course.syllabus.DocetQuerySessiona DocetQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDocetQuery() is false
ComplianceoptionalThis method must be implemented if supportsDocetQuery() is true.
MethodgetDocetQuerySessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the Docet
Returnosid.course.syllabus.DocetQuerySessiona DocetQuerySession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDocetQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDocetQuery() and supportsVisibleFederation() are true
MethodgetDocetSearchSession
Description

Gets the OsidSession associated with the docet search service.

Returnosid.course.syllabus.DocetSearchSessiona DocetSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDocetSearch() is false
ComplianceoptionalThis method must be implemented if supportsDocetSearch() is true.
MethodgetDocetSearchSessionForCourseCatalog
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the Docet
Returnosid.course.syllabus.DocetSearchSessiona DocetSearchSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDocetSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDocetSearch() and supportsVisibleFederation() are true
MethodgetDocetAdminSession
Description

Gets the OsidSession associated with the docet administrative service.

Returnosid.course.syllabus.DocetAdminSessiona DocetAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDocetAdmin() is false
ComplianceoptionalThis method must be implemented if supportsDocetAdmin() is true.
MethodgetDocetAdminSessionForCourseCatalog
Description

Gets the OsidSession associated with the docet administrative service for the given course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of the Docet
Returnosid.course.syllabus.DocetAdminSessiona DocetAdminSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDocetAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDocetAdmin() and supportsVisibleFederation() are true
MethodgetDocetNotificationSession
Description

Gets the OsidSession associated with the docet notification service.

Parametersosid.course.syllabus.DocetReceiverdocetReceiverthe receiver
Returnosid.course.syllabus.DocetNotificationSessiona DocetNotificationSession
ErrorsNULL_ARGUMENT docetReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDocetNotification() is false
ComplianceoptionalThis method must be implemented if supportsDocetNotification() is true.
MethodgetDocetNotificationSessionForCourseCatalog
Description

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

Parametersosid.course.syllabus.DocetReceiverdocetReceiverthe receiver
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.course.syllabus.DocetNotificationSessiona DocetNotificationSession
ErrorsNOT_FOUNDno CourseCatalog found by the given Id
NULL_ARGUMENT docetReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDocetNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDocetNotification() and supportsVisibleFederation() are true
MethodgetDocetCourseCatalogSession
Description

Gets the session for retrieving docet to course catalog mappings.

Returnosid.course.syllabus.DocetCourseCatalogSessiona DocetCourseCatalogSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDocetCourseCatalog() is false
ComplianceoptionalThis method must be implemented if supportsDocetCourseCatalog() is true.
MethodgetDocetCourseCatalogAssignmentSession
Description

Gets the session for assigning docet to course catalog mappings.

Returnosid.course.syllabus.DocetCourseCatalogAssignmentSessiona DocetCourseCatalogAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDocetCourseCatalogAssignment() is false
ComplianceoptionalThis method must be implemented if supportsDocetCourseCatalogAssignment() is true.
MethodgetDocetSmartCourseCatalogSession
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the course catalog
Returnosid.course.syllabus.DocetSmartCourseCatalogSessiona DocetSmartCourseCatalogSession
ErrorsNOT_FOUND courseCatalogId not found
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDocetSmartCourseCatalog() is false
ComplianceoptionalThis method must be implemented if supportsDocetSmartCourseCatalog() is true.
MethodgetCourseSyllabusBatchManager
Description

Gets a CourseSyllabusBatchManager.

Returnosid.course.syllabus.batch.CourseSyllabusBatchManagera CourseSyllabusBatchManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCourseSyllabusBatch() is false
ComplianceoptionalThis method must be implemented if supportsCourseSyllabusBatchj() is true.