org.osid.course.syllabus

Interface CourseSyllabusManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, CourseSyllabusProfile, OsidManager, OsidProfile, Sourceable

public interface CourseSyllabusManager
extends OsidManager, CourseSyllabusProfile

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.

Method Summary

Methods

Modifier and Type	Method and Description
CourseSyllabusBatchManager	getCourseSyllabusBatchManager() Gets a CourseSyllabusBatchManager.
DocetAdminSession	getDocetAdminSession() Gets the OsidSession associated with the docet administrative service.
DocetAdminSession	getDocetAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the docet administrative service for the given course catalog.
DocetCourseCatalogAssignmentSession	getDocetCourseCatalogAssignmentSession() Gets the session for assigning docet to course catalog mappings.
DocetCourseCatalogSession	getDocetCourseCatalogSession() Gets the session for retrieving docet to course catalog mappings.
DocetLookupSession	getDocetLookupSession() Gets the OsidSession associated with the docet lookup service.
DocetLookupSession	getDocetLookupSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the docet lookup service for the given course catalog.
DocetNotificationSession	getDocetNotificationSession(DocetReceiver docetReceiver) Gets the OsidSession associated with the docet notification service.
DocetNotificationSession	getDocetNotificationSessionForCourseCatalog(DocetReceiver docetReceiver, Id courseCatalogId) Gets the OsidSession associated with the docet notification service for the given course catalog.
DocetQuerySession	getDocetQuerySession() Gets the OsidSession associated with the docet query service.
DocetQuerySession	getDocetQuerySessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the docet query service for the given course catalog.
DocetSearchSession	getDocetSearchSession() Gets the OsidSession associated with the docet search service.
DocetSearchSession	getDocetSearchSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the docet search service for the given course catalog.
DocetSmartCourseCatalogSession	getDocetSmartCourseCatalogSession(Id courseCatalogId) Gets the session associated with the docet smart course catalog for the given course catalog.
ModuleAdminSession	getModuleAdminSession() Gets the OsidSession associated with the module administration service.
ModuleAdminSession	getModuleAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the module administration service for the given course catalog.
ModuleCourseCatalogAssignmentSession	getModuleCourseCatalogAssignmentSession() Gets the session for assigning module to course catalog mappings.
ModuleCourseCatalogSession	getModuleCourseCatalogSession() Gets the session for retrieving module to course catalog mappings.
ModuleLookupSession	getModuleLookupSession() Gets the OsidSession associated with the module lookup service.
ModuleLookupSession	getModuleLookupSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the module lookup service for the given course catalog.
ModuleNotificationSession	getModuleNotificationSession(ModuleReceiver moduleReceiver) Gets the OsidSession associated with the module notification service.
ModuleNotificationSession	getModuleNotificationSessionForCourseCatalog(ModuleReceiver moduleReceiver, Id courseCatalogId) Gets the OsidSession associated with the module notification service for the given course catalog.
ModuleQuerySession	getModuleQuerySession() Gets the OsidSession associated with the module query service.
ModuleQuerySession	getModuleQuerySessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the module query service for the given course catalog.
ModuleSearchSession	getModuleSearchSession() Gets the OsidSession associated with the module search service.
ModuleSearchSession	getModuleSearchSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the module search service for the given course catalog.
ModuleSmartCourseCatalogSession	getModuleSmartCourseCatalogSession(Id courseCatalogId) Gets the session associated with the module smart course catalog for the given course catalog.
SyllabusAdminSession	getSyllabusAdminSession() Gets the OsidSession associated with the syllabus administration service.
SyllabusAdminSession	getSyllabusAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the syllabus administration service for the given course catalog.
SyllabusCourseCatalogAssignmentSession	getSyllabusCourseCatalogAssignmentSession() Gets the session for assigning syllabus to course catalog mappings.
SyllabusCourseCatalogSession	getSyllabusCourseCatalogSession() Gets the session for retrieving syllabus to course catalog mappings.
SyllabusLookupSession	getSyllabusLookupSession() Gets the OsidSession associated with the syllabus lookup service.
SyllabusLookupSession	getSyllabusLookupSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the syllabus lookup service for the given course catalog.
SyllabusNotificationSession	getSyllabusNotificationSession(SyllabusReceiver syllabusReceiver) Gets the OsidSession associated with the syllabus notification service.
SyllabusNotificationSession	getSyllabusNotificationSessionForCourseCatalog(SyllabusReceiver syllabusReceiver, Id courseCatalogId) Gets the OsidSession associated with the syllabus notification service for the given course catalog.
SyllabusQuerySession	getSyllabusQuerySession() Gets the OsidSession associated with the syllabus query service.
SyllabusQuerySession	getSyllabusQuerySessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the syllabus query service for the given course catalog.
SyllabusSearchSession	getSyllabusSearchSession() Gets the OsidSession associated with the syllabus search service.
SyllabusSearchSession	getSyllabusSearchSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the syllabus search service for the given course catalog.
SyllabusSmartCourseCatalogSession	getSyllabusSmartCourseCatalogSession(Id courseCatalogId) Gets the session associated with the syllabus smart course catalog for the given course catalog.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.course.syllabus.CourseSyllabusProfile

getDocetRecordTypes, getDocetSearchRecordTypes, getModuleRecordTypes, getModuleSearchRecordTypes, getSyllabusRecordTypes, getSyllabusSearchRecordTypes, supportsCourseSyllabusBatch, supportsDocetAdmin, supportsDocetCourseCatalog, supportsDocetCourseCatalogAssignment, supportsDocetLookup, supportsDocetNotification, supportsDocetQuery, supportsDocetRecordType, supportsDocetSearch, supportsDocetSearchRecordType, supportsDocetSmartCourseCatalog, supportsModule, supportsModuleAdmin, supportsModuleCourseCatalog, supportsModuleCourseCatalogAssignment, supportsModuleLookup, supportsModuleNotification, supportsModuleQuery, supportsModuleRecordType, supportsModuleSearch, supportsModuleSearchRecordType, supportsModuleSmartCourseCatalog, supportsSyllabusAdmin, supportsSyllabusCourseCatalog, supportsSyllabusCourseCatalogAssignment, supportsSyllabusLookup, supportsSyllabusNotification, supportsSyllabusQuery, supportsSyllabusRecordType, supportsSyllabusSearch, supportsSyllabusSearchRecordType, supportsSyllabusSmartCourseCatalog, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getSyllabusLookupSession

SyllabusLookupSession getSyllabusLookupSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the syllabus lookup service.

Returns:

a SyllabusLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSyllabusLookup() is false

Compliance:

optional - This method must be implemented if supportsSyllabusLookup() is true.

getSyllabusLookupSessionForCourseCatalog

SyllabusLookupSession getSyllabusLookupSessionForCourseCatalog(Id courseCatalogId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a SyllabusLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSyllabusLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSyllabusLookup() and supportsVisibleFederation() are true

getSyllabusQuerySession

SyllabusQuerySession getSyllabusQuerySession()
                                             throws OperationFailedException

Gets the OsidSession associated with the syllabus query service.

Returns:

a SyllabusQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSyllabusQuery() is false

Compliance:

optional - This method must be implemented if supportsSyllabusQuery() is true.

getSyllabusQuerySessionForCourseCatalog

SyllabusQuerySession getSyllabusQuerySessionForCourseCatalog(Id courseCatalogId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a SyllabusQuerySession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSyllabusQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSyllabusQuery() and supportsVisibleFederation() are true

getSyllabusSearchSession

SyllabusSearchSession getSyllabusSearchSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the syllabus search service.

Returns:

a SyllabusSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSyllabusSearch() is false

Compliance:

optional - This method must be implemented if supportsSyllabusSearch() is true.

getSyllabusSearchSessionForCourseCatalog

SyllabusSearchSession getSyllabusSearchSessionForCourseCatalog(Id courseCatalogId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a SyllabusSearchSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSyllabusSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSyllabusSearch() and supportsVisibleFederation() are true

getSyllabusAdminSession

SyllabusAdminSession getSyllabusAdminSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the syllabus administration service.

Returns:

a SyllabusAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSyllabusAdmin() is false

Compliance:

optional - This method must be implemented if supportsSyllabusAdmin() is true.

getSyllabusAdminSessionForCourseCatalog

SyllabusAdminSession getSyllabusAdminSessionForCourseCatalog(Id courseCatalogId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a SyllabusAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSyllabusAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSyllabusAdmin() and supportsVisibleFederation() are true

getSyllabusNotificationSession

SyllabusNotificationSession getSyllabusNotificationSession(SyllabusReceiver syllabusReceiver)
                                                           throws OperationFailedException

Gets the OsidSession associated with the syllabus notification service.

Parameters:

syllabusReceiver - the receiver

Returns:

a SyllabusNotificationSession

Throws:

NullArgumentException - syllabusReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSyllabusNotification() is false

Compliance:

optional - This method must be implemented if supportsSyllabusNotification() is true.

getSyllabusNotificationSessionForCourseCatalog

SyllabusNotificationSession getSyllabusNotificationSessionForCourseCatalog(SyllabusReceiver syllabusReceiver,
                                                                         Id courseCatalogId)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

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

Parameters:

syllabusReceiver - the receiver

courseCatalogId - the Id of the CourseCatalog

Returns:

a SyllabusNotificationSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - syllabusReceiver or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSyllabusNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSyllabusNotification() and supportsVisibleFederation() are true

getSyllabusCourseCatalogSession

SyllabusCourseCatalogSession getSyllabusCourseCatalogSession()
                                                             throws OperationFailedException

Gets the session for retrieving syllabus to course catalog mappings.

Returns:

a SyllabusCourseCatalogSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSyllabusCourseCatalog() is false

Compliance:

optional - This method must be implemented if supportsSyllabusCourseCatalog() is true.

getSyllabusCourseCatalogAssignmentSession

SyllabusCourseCatalogAssignmentSession getSyllabusCourseCatalogAssignmentSession()
                                                                                 throws OperationFailedException

Gets the session for assigning syllabus to course catalog mappings.

Returns:

a SyllabusCourseCatalogAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSyllabusCourseCatalogAssignment() is false

Compliance:

optional - This method must be implemented if supportsSyllabusCourseCatalogAssignment() is true.

getSyllabusSmartCourseCatalogSession

SyllabusSmartCourseCatalogSession getSyllabusSmartCourseCatalogSession(Id courseCatalogId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

Returns:

a SyllabusSmartCourseCatalogSession

Throws:

NotFoundException - courseCatalogId not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSyllabusSmartCourseCatalog() is false

Compliance:

optional - This method must be implemented if supportsSyllabusSmartCourseCatalog() is true.

getModuleLookupSession

ModuleLookupSession getModuleLookupSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the module lookup service.

Returns:

a ModuleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsModuleLookup() is false

Compliance:

optional - This method must be implemented if supportsModuleLookup() is true.

getModuleLookupSessionForCourseCatalog

ModuleLookupSession getModuleLookupSessionForCourseCatalog(Id courseCatalogId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a ModuleLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsModuleLookup() and supportsVisibleFederation() are true

getModuleQuerySession

ModuleQuerySession getModuleQuerySession()
                                         throws OperationFailedException

Gets the OsidSession associated with the module query service.

Returns:

a ModuleQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsModuleQuery() is false

Compliance:

optional - This method must be implemented if supportsModuleQuery() is true.

getModuleQuerySessionForCourseCatalog

ModuleQuerySession getModuleQuerySessionForCourseCatalog(Id courseCatalogId)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a ModuleQuerySession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModuleQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsModuleQuery() and supportsVisibleFederation() are true

getModuleSearchSession

ModuleSearchSession getModuleSearchSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the module search service.

Returns:

a ModuleSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsModuleSearch() is false

Compliance:

optional - This method must be implemented if supportsModuleSearch() is true.

getModuleSearchSessionForCourseCatalog

ModuleSearchSession getModuleSearchSessionForCourseCatalog(Id courseCatalogId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a ModuleSearchSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModuleSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsModuleSearch() and supportsVisibleFederation() are true

getModuleAdminSession

ModuleAdminSession getModuleAdminSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the module administration service.

Returns:

a ModuleAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsModuleAdmin() is false

Compliance:

optional - This method must be implemented if supportsModuleAdmin() is true.

getModuleAdminSessionForCourseCatalog

ModuleAdminSession getModuleAdminSessionForCourseCatalog(Id courseCatalogId)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a ModuleAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModuleAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsModuleAdmin() and supportsVisibleFederation() are true

getModuleNotificationSession

ModuleNotificationSession getModuleNotificationSession(ModuleReceiver moduleReceiver)
                                                       throws OperationFailedException

Gets the OsidSession associated with the module notification service.

Parameters:

moduleReceiver - the receiver

Returns:

a ModuleNotificationSession

Throws:

NullArgumentException - moduleReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModuleNotification() is false

Compliance:

optional - This method must be implemented if supportsModuleNotification() is true.

getModuleNotificationSessionForCourseCatalog

ModuleNotificationSession getModuleNotificationSessionForCourseCatalog(ModuleReceiver moduleReceiver,
                                                                     Id courseCatalogId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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

Parameters:

moduleReceiver - the receiver

courseCatalogId - the Id of the CourseCatalog

Returns:

a ModuleNotificationSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - moduleReceiver or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModuleNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsModuleNotification() and supportsVisibleFederation() are true

getModuleCourseCatalogSession

ModuleCourseCatalogSession getModuleCourseCatalogSession()
                                                         throws OperationFailedException

Gets the session for retrieving module to course catalog mappings.

Returns:

a ModuleCourseCatalogSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsModuleCourseCatalog() is false

Compliance:

optional - This method must be implemented if supportsModuleCourseCatalog() is true.

getModuleCourseCatalogAssignmentSession

ModuleCourseCatalogAssignmentSession getModuleCourseCatalogAssignmentSession()
                                                                             throws OperationFailedException

Gets the session for assigning module to course catalog mappings.

Returns:

a ModuleCourseCatalogAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsModuleCourseCatalogAssignment() is false

Compliance:

optional - This method must be implemented if supportsModuleCourseCatalogAssignment() is true.

getModuleSmartCourseCatalogSession

ModuleSmartCourseCatalogSession getModuleSmartCourseCatalogSession(Id courseCatalogId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

Returns:

a ModuleSmartCourseCatalogSession

Throws:

NotFoundException - courseCatalogId not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModuleSmartCourseCatalog() is false

Compliance:

optional - This method must be implemented if supportsModuleSmartCourseCatalog() is true.

getDocetLookupSession

DocetLookupSession getDocetLookupSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the docet lookup service.

Returns:

a DocetLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDocetLookup() is false

Compliance:

optional - This method must be implemented if supportsDocetLookup() is true.

getDocetLookupSessionForCourseCatalog

DocetLookupSession getDocetLookupSessionForCourseCatalog(Id courseCatalogId)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

courseCatalogId - the Id of the Docet

Returns:

a DocetLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDocetLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDocetLookup() and supportsVisibleFederation() are true

getDocetQuerySession

DocetQuerySession getDocetQuerySession()
                                       throws OperationFailedException

Gets the OsidSession associated with the docet query service.

Returns:

a DocetQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDocetQuery() is false

Compliance:

optional - This method must be implemented if supportsDocetQuery() is true.

getDocetQuerySessionForCourseCatalog

DocetQuerySession getDocetQuerySessionForCourseCatalog(Id courseCatalogId)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

courseCatalogId - the Id of the Docet

Returns:

a DocetQuerySession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDocetQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDocetQuery() and supportsVisibleFederation() are true

getDocetSearchSession

DocetSearchSession getDocetSearchSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the docet search service.

Returns:

a DocetSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDocetSearch() is false

Compliance:

optional - This method must be implemented if supportsDocetSearch() is true.

getDocetSearchSessionForCourseCatalog

DocetSearchSession getDocetSearchSessionForCourseCatalog(Id courseCatalogId)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

courseCatalogId - the Id of the Docet

Returns:

a DocetSearchSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDocetSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDocetSearch() and supportsVisibleFederation() are true

getDocetAdminSession

DocetAdminSession getDocetAdminSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the docet administrative service.

Returns:

a DocetAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDocetAdmin() is false

Compliance:

optional - This method must be implemented if supportsDocetAdmin() is true.

getDocetAdminSessionForCourseCatalog

DocetAdminSession getDocetAdminSessionForCourseCatalog(Id courseCatalogId)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

courseCatalogId - the Id of the Docet

Returns:

a DocetAdminSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDocetAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDocetAdmin() and supportsVisibleFederation() are true

getDocetNotificationSession

DocetNotificationSession getDocetNotificationSession(DocetReceiver docetReceiver)
                                                     throws OperationFailedException

Gets the OsidSession associated with the docet notification service.

Parameters:

docetReceiver - the receiver

Returns:

a DocetNotificationSession

Throws:

NullArgumentException - docetReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDocetNotification() is false

Compliance:

optional - This method must be implemented if supportsDocetNotification() is true.

getDocetNotificationSessionForCourseCatalog

DocetNotificationSession getDocetNotificationSessionForCourseCatalog(DocetReceiver docetReceiver,
                                                                   Id courseCatalogId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

docetReceiver - the receiver

courseCatalogId - the Id of the CourseCatalog

Returns:

a DocetNotificationSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - docetReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDocetNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDocetNotification() and supportsVisibleFederation() are true

getDocetCourseCatalogSession

DocetCourseCatalogSession getDocetCourseCatalogSession()
                                                       throws OperationFailedException

Gets the session for retrieving docet to course catalog mappings.

Returns:

a DocetCourseCatalogSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDocetCourseCatalog() is false

Compliance:

optional - This method must be implemented if supportsDocetCourseCatalog() is true.

getDocetCourseCatalogAssignmentSession

DocetCourseCatalogAssignmentSession getDocetCourseCatalogAssignmentSession()
                                                                           throws OperationFailedException

Gets the session for assigning docet to course catalog mappings.

Returns:

a DocetCourseCatalogAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDocetCourseCatalogAssignment() is false

Compliance:

optional - This method must be implemented if supportsDocetCourseCatalogAssignment() is true.

getDocetSmartCourseCatalogSession

DocetSmartCourseCatalogSession getDocetSmartCourseCatalogSession(Id courseCatalogId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

Returns:

a DocetSmartCourseCatalogSession

Throws:

NotFoundException - courseCatalogId not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDocetSmartCourseCatalog() is false

Compliance:

optional - This method must be implemented if supportsDocetSmartCourseCatalog() is true.

getCourseSyllabusBatchManager

CourseSyllabusBatchManager getCourseSyllabusBatchManager()
                                                         throws OperationFailedException

Gets a CourseSyllabusBatchManager.

Returns:

a CourseSyllabusBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseSyllabusBatch() is false

Compliance:

optional - This method must be implemented if supportsCourseSyllabusBatchj() is true.