org.osid.course

Interface CourseManager

All Superinterfaces:

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

public interface CourseManager
extends OsidManager, CourseProfile

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

• CourseLookupSession: a session to retrieve courses
• CourseQuerySession: a session to query courses
• CourseSearchSession: a session to search for courses
• CourseAdminSession: a session to create and delete courses
• CourseNotificationSession: a session to receive notifications pertaining to course changes
• CourseCourseCatalogSession: a session to look up course to course catalog mappings
• CourseCourseCatalogAssignmentSession: a session to manage course to course catalog mappings
• CourseSmartCourseCatalogSession: a session to manage dynamic course catalogs of courses

• ActivityUnitLookupSession: a session to retrieve activity units
• ActivityUnitQuerySession: a session to query activity units
• ActivityUnitSearchSession: a session to search for activity units
• ActivityUnitAdminSession: a session to create and delete activity units
• ActivityUnitNotificationSession: a session to receive notifications pertaining to activity unit changes
• ActivityUnitCourseCatalogSession: a session to look up activity unit to course catalog mappings
• ActivityUnitCourseCatalogAssignmentSession: a session to manage activity unit to course catalog mappings
• ActivityUnitSmartCourseCatalogSession: a session to manage dynamic course catalogs of activity units

• CourseOfferingLookupSession: a session to retrieve course offerings
• CourseOfferingQuerySession: a session to query course offerings
• CourseOfferingSearchSession: a session to search for course offerings
• CourseOfferingAdminSession: a session to create and delete course offerings
• CourseOfferingNotificationSession: a session to receive notifications pertaining to course offering changes
• CourseCatalogSession: a session to look up course to course catalog mappings
• CourseOfferingCourseCatalogSession: a session to look up course offering to course catalog mappings
• CourseOfferingCourseCatalogAssignmentSession: a session to manage course offering to course catalog mappings
• CourseOfferingSmartCourseCatalogSession: a session to manage dynamic course catalogs of course offerings

• ActivityLookupSession: a session to retrieve activities
• ActivityLookupSession: a session to query activities
• ActivitySearchSession: a session to search for activities
• ActivityAdminSession: a session to create and delete activities
• ActivityNotificationSession: a session to receive notifications pertaining to activity changes
• ActivityCourseCatalogSession: a session to look up activity to course catalog mappings
• ActivityCourseCatalogAssignmentSession: a session to manage activity to course catalog mappings
• ActivitySmartCourseCatalogAssignmentSession: a session to manage dynamic course catalogs of activities
• ActivityUnravellingSession: a session to expand activities into meeting times

• TermLookupSession: a session to retrieve terms
• TermLookupSession: a session to query terms
• TermSearchSession: a session to search for terms
• TermAdminSession: a session to create and delete terms
• TermNotificationSession: a session to receive notifications pertaining to term changes
• TermHierarchySession: a session to traverse a hierarchy of terms
• TermHierarchyDesignSession: a session to manage a term hierarchy
• TermCourseCatalogSession: a session to look up term to course catalog mappings
• TermCourseCatalogAssignmentSession: a session to manage term to course catalog mappings
• TermSmartCourseCatalogAssignmentSession: a session to manage dynamic course catalogs of terms

• CourseCatalogLookupSession: a session to retrieve course catalogs
• CourseCatalogQuerySession: a session to query course catalogs
• CourseCatalogSearchSession: a session to search for course catalogs
• CourseCatalogAdminSession: a session to create and delete course catalogs
• CourseCatalogNotificationSession: a session to receive notifications pertaining to course catalog changes
• CourseCatalogHierarchySession: a session to traverse a hierarchy of course catalogs
• CourseCatalogHierarchyDesignSession: a session to manage a course catalog hierarchy

Method Summary

Methods

Modifier and Type	Method and Description
ActivityAdminSession	getActivityAdminSession() Gets the OsidSession associated with the activity administration service.
ActivityAdminSession	getActivityAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the activity administration service for the given course catalog.
ActivityCourseCatalogAssignmentSession	getActivityCourseCatalogAssignmentSession() Gets the OsidSession associated with assigning activities to course catalogs.
ActivityCourseCatalogSession	getActivityCourseCatalogSession() Gets the OsidSession to lookup activity/catalog mappings.
ActivityLookupSession	getActivityLookupSession() Gets the OsidSession associated with the activity lookup service.
ActivityLookupSession	getActivityLookupSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the activity lookup service for the given course catalog.
ActivityNotificationSession	getActivityNotificationSession(ActivityReceiver activityReceiver) Gets the OsidSession associated with the activity notification service.
ActivityNotificationSession	getActivityNotificationSessionForCourseCatalog(ActivityReceiver activityReceiver, Id courseCatalogId) Gets the OsidSession associated with the activity notification service for the given course catalog.
ActivityQuerySession	getActivityQuerySession() Gets the OsidSession associated with the activity query service.
ActivityQuerySession	getActivityQuerySessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the activity query service for the given course catalog.
ActivitySearchSession	getActivitySearchSession() Gets the OsidSession associated with the activity search service.
ActivitySearchSession	getActivitySearchSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the activity search service for the given course catalog.
ActivitySmartCourseCatalogSession	getActivitySmartCourseCatalogSession(Id courseCatalogId) Gets the OsidSession associated with the activity smart course catalog service.
ActivityUnitAdminSession	getActivityUnitAdminSession() Gets the OsidSession associated with the activity unit administration service.
ActivityUnitAdminSession	getActivityUnitAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the activity unit administration service for the given course catalog.
ActivityUnitCourseCatalogAssignmentSession	getActivityUnitCourseCatalogAssignmentSession() Gets the OsidSession associated with assigning activity units to course catalogs.
ActivityUnitCourseCatalogSession	getActivityUnitCourseCatalogSession() Gets the OsidSession to lookup activity unit/catalog mappings.
ActivityUnitLookupSession	getActivityUnitLookupSession() Gets the OsidSession associated with the activity unit lookup service.
ActivityUnitLookupSession	getActivityUnitLookupSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the activity unit lookup service for the given course catalog.
ActivityUnitNotificationSession	getActivityUnitNotificationSession(ActivityUnitReceiver activityUnitReceiver) Gets the OsidSession associated with the activity unit notification service.
ActivityUnitNotificationSession	getActivityUnitNotificationSessionForCourseCatalog(ActivityUnitReceiver activityUnitReceiver, Id courseCatalogId) Gets the OsidSession associated with the activity unit notification service for the given course catalog.
CourseQuerySession	getActivityUnitQuerySession() Gets the OsidSession associated with the activity unit query service.
CourseQuerySession	getActivityUnitQuerySessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the activity unit query service for the given course catalog.
ActivityUnitSearchSession	getActivityUnitSearchSession() Gets the OsidSession associated with the activity unit search service.
ActivityUnitSearchSession	getActivityUnitSearchSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the activity unit search service for the given course catalog.
ActivityUnitSmartCourseCatalogSession	getActivityUnitSmartCourseCatalogSession(Id courseCatalogId) Gets the OsidSession associated with the activity unit smart course catalog service.
ActivityUnravellingSession	getActivityUnravellingSession() Gets the OsidSession associated with unravelling activities into meeting times.
ActivityUnravellingSession	getActivityUnravellingSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with unravelling activities into meeting times for the given course catalog.
CourseAdminSession	getCourseAdminSession() Gets the OsidSession associated with the course administration service.
CourseAdminSession	getCourseAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the course administration service for the given course catalog.
CourseBatchManager	getCourseBatchManager() Gets a CourseBatchManager.
CourseCatalogAdminSession	getCourseCatalogAdminSession() Gets the OsidSession associated with the course catalog administrative service.
CourseCatalogHierarchyDesignSession	getCourseCatalogHierarchyDesignSession() Gets the OsidSession associated with the course catalog hierarchy design service.
CourseCatalogHierarchySession	getCourseCatalogHierarchySession() Gets the OsidSession associated with the course catalog hierarchy service.
CourseCatalogLookupSession	getCourseCatalogLookupSession() Gets the OsidSession associated with the course catalog lookup service.
CourseCatalogNotificationSession	getCourseCatalogNotificationSession(CourseCatalogReceiver courseCatalogReceiver) Gets the OsidSession associated with the course catalog notification service.
CourseCatalogQuerySession	getCourseCatalogQuerySession() Gets the OsidSession associated with the course catalog query service.
CourseCatalogSearchSession	getCourseCatalogSearchSession() Gets the OsidSession associated with the course catalog search service.
CourseChronicleManager	getCourseChronicleManager() Gets a CourseChronicleManager.
CourseCourseCatalogAssignmentSession	getCourseCourseCatalogAssignmentSession() Gets the OsidSession associated with assigning courses to course catalogs.
CourseCourseCatalogSession	getCourseCourseCatalogSession() Gets the OsidSession to lookup course/catalog mappings.
CourseLookupSession	getCourseLookupSession() Gets the OsidSession associated with the course lookup service.
CourseLookupSession	getCourseLookupSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the course lookup service for the given course catalog.
CourseNotificationSession	getCourseNotificationSession(CourseReceiver courseReceiver) Gets the OsidSession associated with the course notification service.
CourseNotificationSession	getCourseNotificationSessionForCourseCatalog(CourseReceiver courseReceiver, Id courseCatalogId) Gets the OsidSession associated with the course notification service for the given course catalog.
CourseOfferingAdminSession	getCourseOfferingAdminSession() Gets the OsidSession associated with the course offering administration service.
CourseOfferingAdminSession	getCourseOfferingAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the course offering administration service for the given course catalog.
CourseOfferingCourseCatalogAssignmentSession	getCourseOfferingCourseCatalogAssignmentSession() Gets the OsidSession associated with assigning course offerings to course catalogs.
CourseOfferingCourseCatalogSession	getCourseOfferingCourseCatalogSession() Gets the OsidSession to lookup course offering/catalog mappings.
CourseOfferingLookupSession	getCourseOfferingLookupSession() Gets the OsidSession associated with the course offering lookup service.
CourseOfferingLookupSession	getCourseOfferingLookupSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the course offering lookup service for the given course catalog.
CourseOfferingNotificationSession	getCourseOfferingNotificationSession(CourseOfferingReceiver courseOfferingReceiver) Gets the OsidSession associated with the course offering notification service.
CourseOfferingNotificationSession	getCourseOfferingNotificationSessionForCourseCatalog(CourseOfferingReceiver courseOfferingReceiver, Id courseCatalogId) Gets the OsidSession associated with the course offering notification service for the given course catalog.
CourseQuerySession	getCourseOfferingQuerySession() Gets the OsidSession associated with the course offering query service.
CourseQuerySession	getCourseOfferingQuerySessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the course offering query service for the given course catalog.
CourseOfferingSearchSession	getCourseOfferingSearchSession() Gets the OsidSession associated with the course offering search service.
CourseOfferingSearchSession	getCourseOfferingSearchSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the course offering search service for the given course catalog.
CourseOfferingSmartCourseCatalogSession	getCourseOfferingSmartCourseCatalogSession(Id courseCatalogId) Gets the OsidSession associated with the course offering smart course catalog service.
CoursePlanManager	getCoursePlanManager() Gets a CoursePlanManager.
CourseProgramManager	getCourseProgramManager() Gets a CourseProgramManager.
CourseQuerySession	getCourseQuerySession() Gets the OsidSession associated with the course query service.
CourseQuerySession	getCourseQuerySessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the course query service for the given course catalog.
CourseRegistrationManager	getCourseRegistrationManager() Gets a CourseRegistrationManager.
CourseRequisiteManager	getCourseRequisiteManager() Gets a CourseRequisiteManager.
CourseSearchSession	getCourseSearchSession() Gets the OsidSession associated with the course search service.
CourseSearchSession	getCourseSearchSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the course search service for the given course catalog.
CourseSmartCourseCatalogSession	getCourseSmartCourseCatalogSession(Id courseCatalogId) Gets the OsidSession associated with the course smart course catalog service.
CourseSyllabusManager	getCourseSyllabusManager() Gets a CourseSyllabusManager.
TermAdminSession	getTermAdminSession() Gets the OsidSession associated with the term administration service.
TermAdminSession	getTermAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the term administration service for the given course catalog.
TermCourseCatalogAssignmentSession	getTermCourseCatalogAssignmentSession() Gets the OsidSession associated with assigning terms to course catalogs.
TermCourseCatalogSession	getTermCourseCatalogSession() Gets the OsidSession to lookup term/catalog mappings.
TermHierarchyDesignSession	getTermHierarchyDesignSession() Gets the term hierarchy design session.
TermHierarchyDesignSession	getTermHierarchyDesignSessionForCourseCatalog(Id courseCatalogId) Gets the term hierarchy design session for the given course catalog.
TermHierarchySession	getTermHierarchySession() Gets the term hierarchy traversal session.
TermHierarchySession	getTermHierarchySessionForCourseCatalog(Id courseCatalogId) Gets the term hierarchy traversal session for the given course catalog.
TermLookupSession	getTermLookupSession() Gets the OsidSession associated with the term lookup service.
TermLookupSession	getTermLookupSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the term lookup service for the given course catalog.
TermNotificationSession	getTermNotificationSession(TermReceiver termReceiver) Gets the OsidSession associated with the term notification service.
TermNotificationSession	getTermNotificationSessionForCourseCatalog(TermReceiver termReceiver, Id courseCatalogId) Gets the OsidSession associated with the term notification service for the given course catalog.
TermQuerySession	getTermQuerySession() Gets the OsidSession associated with the term query service.
TermQuerySession	getTermQuerySessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the term query service for the given course catalog.
TermSearchSession	getTermSearchSession() Gets the OsidSession associated with the term search service.
TermSearchSession	getTermSearchSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the term search service for the given course catalog.
TermSmartCourseCatalogSession	getTermSmartCourseCatalogSession(Id courseCatalogId) Gets the OsidSession associated with the term smart course catalog service.

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.CourseProfile

getActivityRecordTypes, getActivitySearchRecordTypes, getActivityUnitRecordTypes, getActivityUnitSearchRecordTypes, getCourseCatalogRecordTypes, getCourseCatalogSearchRecordTypes, getCourseOfferingRecordTypes, getCourseOfferingSearchRecordTypes, getCourseRecordTypes, getCourseSearchRecordTypes, getTermRecordTypes, getTermSearchRecordTypes, supportsActivityAdmin, supportsActivityCourseCatalog, supportsActivityCourseCatalogAssignment, supportsActivityLookup, supportsActivityNotification, supportsActivityQuery, supportsActivityRecordType, supportsActivitySearch, supportsActivitySearchRecordType, supportsActivitySmartCourseCatalog, supportsActivityUnitAdmin, supportsActivityUnitCourseCatalog, supportsActivityUnitCourseCatalogAssignment, supportsActivityUnitLookup, supportsActivityUnitNotification, supportsActivityUnitQuery, supportsActivityUnitRecordType, supportsActivityUnitSearch, supportsActivityUnitSearchRecordType, supportsActivityUnitSmartCourseCatalog, supportsActivityUnravelling, supportsCourseAdmin, supportsCourseBatch, supportsCourseCatalogAdmin, supportsCourseCatalogHierarchy, supportsCourseCatalogHierarchyDesign, supportsCourseCatalogLookup, supportsCourseCatalogNotification, supportsCourseCatalogQuery, supportsCourseCatalogRecordType, supportsCourseCatalogSearch, supportsCourseCatalogSearchRecordType, supportsCourseChronicle, supportsCourseCourseCatalog, supportsCourseCourseCatalogAssignment, supportsCourseLookup, supportsCourseNotification, supportsCourseOfferingAdmin, supportsCourseOfferingCourseCatalog, supportsCourseOfferingCourseCatalogAssignment, supportsCourseOfferingLookup, supportsCourseOfferingNotification, supportsCourseOfferingQuery, supportsCourseOfferingRecordType, supportsCourseOfferingSearch, supportsCourseOfferingSearchRecordType, supportsCourseOfferingSmartCourseCatalog, supportsCoursePlan, supportsCourseProgram, supportsCourseQuery, supportsCourseRecordType, supportsCourseRegistration, supportsCourseRequisite, supportsCourseSearch, supportsCourseSearchRecordType, supportsCourseSmartCourseCatalog, supportsCourseSyllabus, supportsTermAdmin, supportsTermCourseCatalog, supportsTermCourseCatalogAssignment, supportsTermHierarchy, supportsTermHierarchyDesign, supportsTermLookup, supportsTermNotification, supportsTermQuery, supportsTermRecordType, supportsTermSearch, supportsTermSearchRecordType, supportsTermSmartCourseCatalog, 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

getCourseLookupSession

CourseLookupSession getCourseLookupSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the course lookup service.

Returns:

a CourseLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseLookup() is false

Compliance:

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

getCourseLookupSessionForCourseCatalog

CourseLookupSession getCourseLookupSessionForCourseCatalog(Id courseCatalogId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

Returns:

a CourseLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseLookup() or supportsVisibleFederation() is false

Compliance:

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

getCourseQuerySession

CourseQuerySession getCourseQuerySession()
                                         throws OperationFailedException

Gets the OsidSession associated with the course query service.

Returns:

a CourseQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseQuery() is false

Compliance:

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

getCourseQuerySessionForCourseCatalog

CourseQuerySession getCourseQuerySessionForCourseCatalog(Id courseCatalogId)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a CourseQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseQuery() or supportsVisibleFederation() is false

Compliance:

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

getCourseSearchSession

CourseSearchSession getCourseSearchSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the course search service.

Returns:

a CourseSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseSearch() is false

Compliance:

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

getCourseSearchSessionForCourseCatalog

CourseSearchSession getCourseSearchSessionForCourseCatalog(Id courseCatalogId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a CourseSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseSearch() or supportsVisibleFederation() is false

Compliance:

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

getCourseAdminSession

CourseAdminSession getCourseAdminSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the course administration service.

Returns:

a CourseAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseAdmin() is false

Compliance:

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

getCourseAdminSessionForCourseCatalog

CourseAdminSession getCourseAdminSessionForCourseCatalog(Id courseCatalogId)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a CourseAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCourseNotificationSession

CourseNotificationSession getCourseNotificationSession(CourseReceiver courseReceiver)
                                                       throws OperationFailedException

Gets the OsidSession associated with the course notification service.

Parameters:

courseReceiver - the notification callback

Returns:

a CourseNotificationSession

Throws:

NullArgumentException - courseReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseNotification() is false

Compliance:

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

getCourseNotificationSessionForCourseCatalog

CourseNotificationSession getCourseNotificationSessionForCourseCatalog(CourseReceiver courseReceiver,
                                                                     Id courseCatalogId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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

Parameters:

courseReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

Returns:

a CourseNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseReceiver or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseNotification() or supportsVisibleFederation() is false

Compliance:

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

getCourseCourseCatalogSession

CourseCourseCatalogSession getCourseCourseCatalogSession()
                                                         throws OperationFailedException

Gets the OsidSession to lookup course/catalog mappings.

Returns:

a CourseCourseCourseCatalogSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCourseCatalog() is false

Compliance:

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

getCourseCourseCatalogAssignmentSession

CourseCourseCatalogAssignmentSession getCourseCourseCatalogAssignmentSession()
                                                                             throws OperationFailedException

Gets the OsidSession associated with assigning courses to course catalogs.

Returns:

a CourseCourseCatalogAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCourseCatalogAssignment() is false

Compliance:

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

getCourseSmartCourseCatalogSession

CourseSmartCourseCatalogSession getCourseSmartCourseCatalogSession(Id courseCatalogId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

Gets the OsidSession associated with the course smart course catalog service.

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a CourseSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseSmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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

getActivityUnitLookupSession

ActivityUnitLookupSession getActivityUnitLookupSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the activity unit lookup service.

Returns:

an ActivityUnitSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitLookup() is false

Compliance:

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

getActivityUnitLookupSessionForCourseCatalog

ActivityUnitLookupSession getActivityUnitLookupSessionForCourseCatalog(Id courseCatalogId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

Returns:

an ActivityUnitLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitLookup() or supportsVisibleFederation() is false

Compliance:

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

getActivityUnitQuerySession

CourseQuerySession getActivityUnitQuerySession()
                                               throws OperationFailedException

Gets the OsidSession associated with the activity unit query service.

Returns:

an ActivityUnitQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitQuery() is false

Compliance:

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

getActivityUnitQuerySessionForCourseCatalog

CourseQuerySession getActivityUnitQuerySessionForCourseCatalog(Id courseCatalogId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityUnitQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitQuery() or supportsVisibleFederation() is false

Compliance:

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

getActivityUnitSearchSession

ActivityUnitSearchSession getActivityUnitSearchSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the activity unit search service.

Returns:

an ActivityUnitSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitSearch() is false

Compliance:

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

getActivityUnitSearchSessionForCourseCatalog

ActivityUnitSearchSession getActivityUnitSearchSessionForCourseCatalog(Id courseCatalogId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityUnitSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitSearch() or supportsVisibleFederation() is false

Compliance:

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

getActivityUnitAdminSession

ActivityUnitAdminSession getActivityUnitAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the activity unit administration service.

Returns:

an ActivityUnitAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitAdmin() is false

Compliance:

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

getActivityUnitAdminSessionForCourseCatalog

ActivityUnitAdminSession getActivityUnitAdminSessionForCourseCatalog(Id courseCatalogId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityUnitAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitAdmin() or supportsVisibleFederation() is false

Compliance:

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

getActivityUnitNotificationSession

ActivityUnitNotificationSession getActivityUnitNotificationSession(ActivityUnitReceiver activityUnitReceiver)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the activity unit notification service.

Parameters:

activityUnitReceiver - the notification callback

Returns:

an ActivityUnitNotificationSession

Throws:

NullArgumentException - activityUnitReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitNotification() is false

Compliance:

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

getActivityUnitNotificationSessionForCourseCatalog

ActivityUnitNotificationSession getActivityUnitNotificationSessionForCourseCatalog(ActivityUnitReceiver activityUnitReceiver,
                                                                                 Id courseCatalogId)
                                                                                   throws NotFoundException,
                                                                                          OperationFailedException

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

Parameters:

activityUnitReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityUnitNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - activityUnitReceiver or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitNotification() or supportsVisibleFederation() is false

Compliance:

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

getActivityUnitCourseCatalogSession

ActivityUnitCourseCatalogSession getActivityUnitCourseCatalogSession()
                                                                     throws OperationFailedException

Gets the OsidSession to lookup activity unit/catalog mappings.

Returns:

an ActivityUnitCourseCatalogSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitCourseCatalog() is false

Compliance:

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

getActivityUnitCourseCatalogAssignmentSession

ActivityUnitCourseCatalogAssignmentSession getActivityUnitCourseCatalogAssignmentSession()
                                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning activity units to course catalogs.

Returns:

an ActivityUnitCourseCatalogAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitCourseCatalogAssignment() is false

Compliance:

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

getActivityUnitSmartCourseCatalogSession

ActivityUnitSmartCourseCatalogSession getActivityUnitSmartCourseCatalogSession(Id courseCatalogId)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

Gets the OsidSession associated with the activity unit smart course catalog service.

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityUnitSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitSmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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

getCourseOfferingLookupSession

CourseOfferingLookupSession getCourseOfferingLookupSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the course offering lookup service.

Returns:

a CourseOfferingSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingLookup() is false

Compliance:

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

getCourseOfferingLookupSessionForCourseCatalog

CourseOfferingLookupSession getCourseOfferingLookupSessionForCourseCatalog(Id courseCatalogId)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

Returns:

a CourseOfferingLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingLookup() or supportsVisibleFederation() is false

Compliance:

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

getCourseOfferingQuerySession

CourseQuerySession getCourseOfferingQuerySession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the course offering query service.

Returns:

a CourseOfferingQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingQuery() is false

Compliance:

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

getCourseOfferingQuerySessionForCourseCatalog

CourseQuerySession getCourseOfferingQuerySessionForCourseCatalog(Id courseCatalogId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a CourseOfferingQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingQuery() or supportsVisibleFederation() is false

Compliance:

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

getCourseOfferingSearchSession

CourseOfferingSearchSession getCourseOfferingSearchSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the course offering search service.

Returns:

a CourseOfferingSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingSearch() is false

Compliance:

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

getCourseOfferingSearchSessionForCourseCatalog

CourseOfferingSearchSession getCourseOfferingSearchSessionForCourseCatalog(Id courseCatalogId)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a CourseOfferingSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingSearch() or supportsVisibleFederation() is false

Compliance:

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

getCourseOfferingAdminSession

CourseOfferingAdminSession getCourseOfferingAdminSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the course offering administration service.

Returns:

a CourseOfferingAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingAdmin() is false

Compliance:

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

getCourseOfferingAdminSessionForCourseCatalog

CourseOfferingAdminSession getCourseOfferingAdminSessionForCourseCatalog(Id courseCatalogId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a CourseOfferingAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCourseOfferingNotificationSession

CourseOfferingNotificationSession getCourseOfferingNotificationSession(CourseOfferingReceiver courseOfferingReceiver)
                                                                       throws OperationFailedException

Gets the OsidSession associated with the course offering notification service.

Parameters:

courseOfferingReceiver - the notification callback

Returns:

a CourseOfferingNotificationSession

Throws:

NullArgumentException - courseOfferingReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingNotification() is false

Compliance:

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

getCourseOfferingNotificationSessionForCourseCatalog

CourseOfferingNotificationSession getCourseOfferingNotificationSessionForCourseCatalog(CourseOfferingReceiver courseOfferingReceiver,
                                                                                     Id courseCatalogId)
                                                                                       throws NotFoundException,
                                                                                              OperationFailedException

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

Parameters:

courseOfferingReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

Returns:

a CourseOfferingNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseOfferingReceiver or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingNotification() or supportsVisibleFederation() is false

Compliance:

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

getCourseOfferingCourseCatalogSession

CourseOfferingCourseCatalogSession getCourseOfferingCourseCatalogSession()
                                                                         throws OperationFailedException

Gets the OsidSession to lookup course offering/catalog mappings.

Returns:

a CourseOfferingCourseCatalogSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingCourseCatalog() is false

Compliance:

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

getCourseOfferingCourseCatalogAssignmentSession

CourseOfferingCourseCatalogAssignmentSession getCourseOfferingCourseCatalogAssignmentSession()
                                                                                             throws OperationFailedException

Gets the OsidSession associated with assigning course offerings to course catalogs.

Returns:

a CourseOfferingCourseCatalogAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingCourseCatalogAssignment() is false

Compliance:

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

getCourseOfferingSmartCourseCatalogSession

CourseOfferingSmartCourseCatalogSession getCourseOfferingSmartCourseCatalogSession(Id courseCatalogId)
                                                                                   throws NotFoundException,
                                                                                          OperationFailedException

Gets the OsidSession associated with the course offering smart course catalog service.

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a CourseOfferingSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingSmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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

getActivityLookupSession

ActivityLookupSession getActivityLookupSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the activity lookup service.

Returns:

an ActivityLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityLookup() is false

Compliance:

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

getActivityLookupSessionForCourseCatalog

ActivityLookupSession getActivityLookupSessionForCourseCatalog(Id courseCatalogId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityLookup() or supportsVisibleFederation() is false

Compliance:

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

getActivityQuerySession

ActivityQuerySession getActivityQuerySession()
                                             throws OperationFailedException

Gets the OsidSession associated with the activity query service.

Returns:

an ActivityQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityQuery() is false

Compliance:

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

getActivityQuerySessionForCourseCatalog

ActivityQuerySession getActivityQuerySessionForCourseCatalog(Id courseCatalogId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityQuery() or supportsVisibleFederation() is false

Compliance:

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

getActivitySearchSession

ActivitySearchSession getActivitySearchSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the activity search service.

Returns:

an ActivitySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivitySearch() is false

Compliance:

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

getActivitySearchSessionForCourseCatalog

ActivitySearchSession getActivitySearchSessionForCourseCatalog(Id courseCatalogId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivitySearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivitySearch() or supportsVisibleFederation() is false

Compliance:

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

getActivityAdminSession

ActivityAdminSession getActivityAdminSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the activity administration service.

Returns:

an ActivityAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityAdmin() is false

Compliance:

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

getActivityAdminSessionForCourseCatalog

ActivityAdminSession getActivityAdminSessionForCourseCatalog(Id courseCatalogId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityAdmin() or supportsVisibleFederation() is false

Compliance:

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

getActivityNotificationSession

ActivityNotificationSession getActivityNotificationSession(ActivityReceiver activityReceiver)
                                                           throws OperationFailedException

Gets the OsidSession associated with the activity notification service.

Parameters:

activityReceiver - the notification callback

Returns:

an ActivityNotificationSession

Throws:

NullArgumentException - activityReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityNotification() is false

Compliance:

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

getActivityNotificationSessionForCourseCatalog

ActivityNotificationSession getActivityNotificationSessionForCourseCatalog(ActivityReceiver activityReceiver,
                                                                         Id courseCatalogId)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

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

Parameters:

activityReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - activityReceiver or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityNotification() or supportsVisibleFederation() is false

Compliance:

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

getActivityCourseCatalogSession

ActivityCourseCatalogSession getActivityCourseCatalogSession()
                                                             throws OperationFailedException

Gets the OsidSession to lookup activity/catalog mappings.

Returns:

an ActivityCourseCatalogSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityCourseCatalog() is false

Compliance:

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

getActivityCourseCatalogAssignmentSession

ActivityCourseCatalogAssignmentSession getActivityCourseCatalogAssignmentSession()
                                                                                 throws OperationFailedException

Gets the OsidSession associated with assigning activities to course catalogs.

Returns:

an ActivityCourseCatalogAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityCourseCatalogAssignment() is false

Compliance:

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

getActivitySmartCourseCatalogSession

ActivitySmartCourseCatalogSession getActivitySmartCourseCatalogSession(Id courseCatalogId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets the OsidSession associated with the activity smart course catalog service.

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivitySmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivitySmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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

getActivityUnravellingSession

ActivityUnravellingSession getActivityUnravellingSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with unravelling activities into meeting times.

Returns:

an ActivityUnravellingSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnravelling() is false

Compliance:

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

getActivityUnravellingSessionForCourseCatalog

ActivityUnravellingSession getActivityUnravellingSessionForCourseCatalog(Id courseCatalogId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

Gets the OsidSession associated with unravelling activities into meeting times for the given course catalog.

Parameters:

courseCatalogId - the Id of the course catalog

Returns:

an ActivityUnravellingSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnravelling() or supportsVisibleFederation() is false

Compliance:

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

getTermLookupSession

TermLookupSession getTermLookupSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the term lookup service.

Returns:

a TermLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTermLookup() is false

Compliance:

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

getTermLookupSessionForCourseCatalog

TermLookupSession getTermLookupSessionForCourseCatalog(Id courseCatalogId)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a TermLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermLookup() or supportsVisibleFederation() is false

Compliance:

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

getTermQuerySession

TermQuerySession getTermQuerySession()
                                     throws OperationFailedException

Gets the OsidSession associated with the term query service.

Returns:

a TermQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTermQuery() is false

Compliance:

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

getTermQuerySessionForCourseCatalog

TermQuerySession getTermQuerySessionForCourseCatalog(Id courseCatalogId)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a TermQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermQuery() or supportsVisibleFederation() is false

Compliance:

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

getTermSearchSession

TermSearchSession getTermSearchSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the term search service.

Returns:

a TermSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTermSearch() is false

Compliance:

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

getTermSearchSessionForCourseCatalog

TermSearchSession getTermSearchSessionForCourseCatalog(Id courseCatalogId)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a TermSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermSearch() or supportsVisibleFederation() is false

Compliance:

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

getTermAdminSession

TermAdminSession getTermAdminSession()
                                     throws OperationFailedException

Gets the OsidSession associated with the term administration service.

Returns:

a TermAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTermAdmin() is false

Compliance:

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

getTermAdminSessionForCourseCatalog

TermAdminSession getTermAdminSessionForCourseCatalog(Id courseCatalogId)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a TermAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermAdmin() or supportsVisibleFederation() is false

Compliance:

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

getTermNotificationSession

TermNotificationSession getTermNotificationSession(TermReceiver termReceiver)
                                                   throws OperationFailedException

Gets the OsidSession associated with the term notification service.

Parameters:

termReceiver - the notification callback

Returns:

a TermNotificationSession

Throws:

NullArgumentException - termReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermNotification() is false

Compliance:

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

getTermNotificationSessionForCourseCatalog

TermNotificationSession getTermNotificationSessionForCourseCatalog(TermReceiver termReceiver,
                                                                 Id courseCatalogId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

termReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

Returns:

a TermNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - termReceiver or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermNotification() or supportsVisibleFederation() is false

Compliance:

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

getTermHierarchySession

TermHierarchySession getTermHierarchySession()
                                             throws OperationFailedException

Gets the term hierarchy traversal session.

Returns:

a TermHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTermHierarchy() is false

Compliance:

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

getTermHierarchySessionForCourseCatalog

TermHierarchySession getTermHierarchySessionForCourseCatalog(Id courseCatalogId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the term hierarchy traversal session for the given course catalog.

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a TermHierarchySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermHierarchy() or supportsVisibleFederation() is false

Compliance:

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

getTermHierarchyDesignSession

TermHierarchyDesignSession getTermHierarchyDesignSession()
                                                         throws OperationFailedException

Gets the term hierarchy design session.

Returns:

a TermHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTermHierarchyDesign() is false

Compliance:

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

getTermHierarchyDesignSessionForCourseCatalog

TermHierarchyDesignSession getTermHierarchyDesignSessionForCourseCatalog(Id courseCatalogId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

Gets the term hierarchy design session for the given course catalog.

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a TermHierarchyDesignSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermHierarchyDesign() or supportsVisibleFederation() is false

Compliance:

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

getTermCourseCatalogSession

TermCourseCatalogSession getTermCourseCatalogSession()
                                                     throws OperationFailedException

Gets the OsidSession to lookup term/catalog mappings.

Returns:

a TermCourseCatalogSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTermCourseCatalog() is false

Compliance:

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

getTermCourseCatalogAssignmentSession

TermCourseCatalogAssignmentSession getTermCourseCatalogAssignmentSession()
                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning terms to course catalogs.

Returns:

a TermCourseCatalogAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTermCourseCatalogAssignment() is false

Compliance:

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

getTermSmartCourseCatalogSession

TermSmartCourseCatalogSession getTermSmartCourseCatalogSession(Id courseCatalogId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the term smart course catalog service.

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a TermSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermSmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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

getCourseCatalogLookupSession

CourseCatalogLookupSession getCourseCatalogLookupSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the course catalog lookup service.

Returns:

a CourseCatalogLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCatalogLookup() is false

Compliance:

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

getCourseCatalogQuerySession

CourseCatalogQuerySession getCourseCatalogQuerySession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the course catalog query service.

Returns:

a CourseCatalogQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCatalogQuery() is false

Compliance:

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

getCourseCatalogSearchSession

CourseCatalogSearchSession getCourseCatalogSearchSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the course catalog search service.

Returns:

a CourseCatalogSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCatalogSearch() is false

Compliance:

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

getCourseCatalogAdminSession

CourseCatalogAdminSession getCourseCatalogAdminSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the course catalog administrative service.

Returns:

a CourseCatalogAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCatalogAdmin() is false

Compliance:

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

getCourseCatalogNotificationSession

CourseCatalogNotificationSession getCourseCatalogNotificationSession(CourseCatalogReceiver courseCatalogReceiver)
                                                                     throws OperationFailedException

Gets the OsidSession associated with the course catalog notification service.

Parameters:

courseCatalogReceiver - the notification callback

Returns:

a CourseCatalogNotificationSession

Throws:

NullArgumentException - courseCatalogReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCatalogNotification() is false

Compliance:

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

getCourseCatalogHierarchySession

CourseCatalogHierarchySession getCourseCatalogHierarchySession()
                                                               throws OperationFailedException

Gets the OsidSession associated with the course catalog hierarchy service.

Returns:

a CourseCatalogHierarchySession for course catalogs

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCatalogHierarchy() is false

Compliance:

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

getCourseCatalogHierarchyDesignSession

CourseCatalogHierarchyDesignSession getCourseCatalogHierarchyDesignSession()
                                                                           throws OperationFailedException

Gets the OsidSession associated with the course catalog hierarchy design service.

Returns:

a HierarchyDesignSession for course catalogs

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCatalogHierarchyDesign() is false

Compliance:

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

getCourseBatchManager

CourseBatchManager getCourseBatchManager()
                                         throws OperationFailedException

Gets a CourseBatchManager.

Returns:

a CourseBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseBatch() is false

Compliance:

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

getCourseProgramManager

CourseProgramManager getCourseProgramManager()
                                             throws OperationFailedException

Gets a CourseProgramManager.

Returns:

a CourseProgramManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseProgram() is false

Compliance:

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

getCourseRegistrationManager

CourseRegistrationManager getCourseRegistrationManager()
                                                       throws OperationFailedException

Gets a CourseRegistrationManager.

Returns:

a CourseRegistrationManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRegistration() is false

Compliance:

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

getCourseRequisiteManager

CourseRequisiteManager getCourseRequisiteManager()
                                                 throws OperationFailedException

Gets a CourseRequisiteManager.

Returns:

a CourseRequisiteManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRequisite() is false

Compliance:

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

getCourseSyllabusManager

CourseSyllabusManager getCourseSyllabusManager()
                                               throws OperationFailedException

Gets a CourseSyllabusManager.

Returns:

a CourseSyllabusManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseSyllabus() is false

Compliance:

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

getCoursePlanManager

CoursePlanManager getCoursePlanManager()
                                       throws OperationFailedException

Gets a CoursePlanManager.

Returns:

a CoursePlanManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCoursePlan() is false

Compliance:

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

getCourseChronicleManager

CourseChronicleManager getCourseChronicleManager()
                                                 throws OperationFailedException

Gets a CourseChronicleManager.

Returns:

a CourseChronicleManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseChronicle() is false

Compliance:

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