Interface CourseSyllabusManager

All Superinterfaces:

AutoCloseable, Closeable, CourseSyllabusProfile, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getDocetRecordTypes()	Gets the supported Docet record types.
TypeList	getDocetSearchRecordTypes()	Gets the supported docet search record types.
TypeList	getModuleRecordTypes()	Gets the supported Module record types.
TypeList	getModuleSearchRecordTypes()	Gets the supported module search record types.
TypeList	getSyllabusRecordTypes()	Gets the supported Syllabus record types.
TypeList	getSyllabusSearchRecordTypes()	Gets the supported syllabus search record types.
boolean	supportsCourseSyllabusBatch()	Tests if a course syllabus batch service is available.
boolean	supportsDocetAdmin()	Tests for the availability of a docet administrative service for creating and deleting docets.
boolean	supportsDocetCourseCatalog()	Tests if a docet to course catalog lookup session is available.
boolean	supportsDocetCourseCatalogAssignment()	Tests if a docet to course catalog assignment session is available.
boolean	supportsDocetLookup()	Tests for the availability of a docet lookup service.
boolean	supportsDocetNotification()	Tests for the availability of a docet notification service.
boolean	supportsDocetQuery()	Tests if querying docetsis available.
boolean	supportsDocetRecordType(Type docetRecordType)	Tests if the given Docet record type is supported.
boolean	supportsDocetSearch()	Tests if searching for docets is available.
boolean	supportsDocetSearchRecordType(Type docetSearchRecordType)	Tests if the given docet search record type is supported.
boolean	supportsDocetSmartCourseCatalog()	Tests if a docet smart course catalog session is available.
boolean	supportsModule()	Tests for the availability of a module service for getting available modules for a resource.
boolean	supportsModuleAdmin()	Tests if searching for modules is available.
boolean	supportsModuleCourseCatalog()	Tests if a module to course catalog lookup session is available.
boolean	supportsModuleCourseCatalogAssignment()	Tests if a module to course catalog assignment session is available.
boolean	supportsModuleLookup()	Tests for the availability of a module lookup service.
boolean	supportsModuleNotification()	Tests if module notification is available.
boolean	supportsModuleQuery()	Tests if querying modules is available.
boolean	supportsModuleRecordType(Type moduleRecordType)	Tests if the given Module record type is supported.
boolean	supportsModuleSearch()	Tests if searching for modules is available.
boolean	supportsModuleSearchRecordType(Type moduleSearchRecordType)	Tests if the given module search record type is supported.
boolean	supportsModuleSmartCourseCatalog()	Tests if a module smart course catalog session is available.
boolean	supportsSyllabusAdmin()	Tests if searching for syllabi is available.
boolean	supportsSyllabusCourseCatalog()	Tests if a syllabus to course catalog lookup session is available.
boolean	supportsSyllabusCourseCatalogAssignment()	Tests if a syllabus to course catalog assignment session is available.
boolean	supportsSyllabusLookup()	Tests for the availability of a syllabus lookup service.
boolean	supportsSyllabusNotification()	Tests if syllabus notification is available.
boolean	supportsSyllabusQuery()	Tests if querying syllabi is available.
boolean	supportsSyllabusRecordType(Type syllabusRecordType)	Tests if the given Syllabus record type is supported.
boolean	supportsSyllabusSearch()	Tests if searching for syllabi is available.
boolean	supportsSyllabusSearchRecordType(Type syllabusSearchRecordType)	Tests if the given syllabus search record type is supported.
boolean	supportsSyllabusSmartCourseCatalog()	Tests if a syllabus smart course catalog session is available.
boolean	supportsVisibleFederation()	Tests if any docet federation is exposed.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsSyllabusLookup()} is {@code 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 {@code supportsSyllabusLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsSyllabusQuery()} is {@code 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 {@code supportsSyllabusQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsSyllabusSearch()} is {@code 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 {@code supportsSyllabusSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsSyllabusAdmin()} is {@code 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 {@code supportsSyllabusAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsSyllabusNotification()} is {@code 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 {@code supportsSyllabusNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsSyllabusCourseCatalog()} is {@code 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 {@code supportsSyllabusCourseCatalogAssignment()} is {@code 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 {@code supportsSyllabusSmartCourseCatalog()} is {@code 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 {@code supportsModuleLookup()} is {@code 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 {@code supportsModuleLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsModuleQuery()} is {@code 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 {@code supportsModuleQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsModuleSearch()} is {@code 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 {@code supportsModuleSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsModuleAdmin()} is {@code 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 {@code supportsModuleAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsModuleNotification()} is {@code 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 {@code supportsModuleNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsModuleCourseCatalog()} is {@code 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 {@code supportsModuleCourseCatalogAssignment()} is {@code 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 {@code supportsModuleSmartCourseCatalog()} is {@code 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 {@code supportsDocetLookup()} is {@code 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 {@code supportsDocetLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDocetQuery()} is {@code 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 {@code supportsDocetQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDocetSearch()} is {@code 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 {@code supportsDocetSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDocetAdmin()} is {@code 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 {@code supportsDocetAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDocetNotification()} is {@code 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 {@code supportsDocetNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDocetCourseCatalog()} is {@code 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 {@code supportsDocetCourseCatalogAssignment()} is {@code 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 {@code supportsDocetSmartCourseCatalog()} is {@code 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 {@code supportsCourseSyllabusBatchj()} is {@code true} .