Interface CourseProxyManager

All Superinterfaces:

AutoCloseable, Closeable, CourseProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface CourseProxyManager
extends OsidProxyManager, CourseProfile

The course manager provides access to course management sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy for the purposes of passing information within a server application environment. 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

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

Methods inherited from interface Closeable

close

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

Modifier and Type	Method	Description
TypeList	getActivityRecordTypes()	Gets the supported Activity record types.
TypeList	getActivitySearchRecordTypes()	Gets the supported Activity search record types.
TypeList	getActivityUnitRecordTypes()	Gets the supported ActivityUnit record types.
TypeList	getActivityUnitSearchRecordTypes()	Gets the supported ActivityUnit search record types.
TypeList	getCourseCatalogRecordTypes()	Gets the supported CourseCatalog record types.
TypeList	getCourseCatalogSearchRecordTypes()	Gets the supported CourseCatalog search record types.
TypeList	getCourseOfferingRecordTypes()	Gets the supported CourseOffering record types.
TypeList	getCourseOfferingSearchRecordTypes()	Gets the supported CourseOffering search record types.
TypeList	getCourseRecordTypes()	Gets the supported Course record types.
TypeList	getCourseSearchRecordTypes()	Gets the supported Course search record types.
TypeList	getTermRecordTypes()	Gets the supported Term record types.
TypeList	getTermSearchRecordTypes()	Gets the supported Term search record types.
boolean	supportsActivityAdmin()	Tests if activity administrative service is supported.
boolean	supportsActivityCourseCatalog()	Tests if an activity cataloging service is supported.
boolean	supportsActivityCourseCatalogAssignment()	Tests if an activity cataloging service is supported.
boolean	supportsActivityLookup()	Tests if looking up activities is supported.
boolean	supportsActivityNotification()	Tests if an activity notification service is supported.
boolean	supportsActivityQuery()	Tests if querying activities is supported.
boolean	supportsActivityRecordType(Type activityRecordType)	Tests if the given Activity record type is supported.
boolean	supportsActivitySearch()	Tests if searching activities is supported.
boolean	supportsActivitySearchRecordType(Type activitySearchRecordType)	Tests if the given Activity search record type is supported.
boolean	supportsActivitySmartCourseCatalog()	Tests if an activity smart course catalog session is available.
boolean	supportsActivityUnitAdmin()	Tests if an activity unit administrative service is supported.
boolean	supportsActivityUnitCourseCatalog()	Tests if an activity unit cataloging service is supported.
boolean	supportsActivityUnitCourseCatalogAssignment()	Tests if an activity unit cataloging service is supported.
boolean	supportsActivityUnitLookup()	Tests if looking up activity units is supported.
boolean	supportsActivityUnitNotification()	Tests if an activity unit notification service is supported.
boolean	supportsActivityUnitQuery()	Tests if querying activity units is supported.
boolean	supportsActivityUnitRecordType(Type activityUnitRecordType)	Tests if the given ActivityUnit record type is supported.
boolean	supportsActivityUnitSearch()	Tests if searching activity units is supported.
boolean	supportsActivityUnitSearchRecordType(Type activityUnitSearchRecordType)	Tests if the given ActivityUnit search record type is supported.
boolean	supportsActivityUnitSmartCourseCatalog()	Tests if an activity unit smart course catalog session is available.
boolean	supportsActivityUnravelling()	Tests if unravelling activities is supported.
boolean	supportsCourseAdmin()	Tests if course administrative service is supported.
boolean	supportsCourseBatch()	Tests for the availability of a course batch service.
boolean	supportsCourseCatalogAdmin()	Tests if course catalog administrative service is supported.
boolean	supportsCourseCatalogHierarchy()	Tests for the availability of a course catalog hierarchy traversal service.
boolean	supportsCourseCatalogHierarchyDesign()	Tests for the availability of a course catalog hierarchy design service.
boolean	supportsCourseCatalogLookup()	Tests if looking up course catalogs is supported.
boolean	supportsCourseCatalogNotification()	Tests if a course catalog notification service is supported.
boolean	supportsCourseCatalogQuery()	Tests if querying course catalogs is supported.
boolean	supportsCourseCatalogRecordType(Type courseCatalogRecordType)	Tests if the given CourseCatalog record type is supported.
boolean	supportsCourseCatalogSearch()	Tests if searching course catalogs is supported.
boolean	supportsCourseCatalogSearchRecordType(Type courseCatalogSearchRecordType)	Tests if the given CourseCatalog search record type is supported.
boolean	supportsCourseChronicle()	Tests for the availability of a course chronicle service.
boolean	supportsCourseCourseCatalog()	Tests if a course cataloging service is supported.
boolean	supportsCourseCourseCatalogAssignment()	Tests if a course cataloging service is supported.
boolean	supportsCourseLookup()	Tests if looking up courses is supported.
boolean	supportsCourseNotification()	Tests if a course notification service is supported.
boolean	supportsCourseOfferingAdmin()	Tests if course offering administrative service is supported.
boolean	supportsCourseOfferingCourseCatalog()	Tests if a course offering cataloging service is supported.
boolean	supportsCourseOfferingCourseCatalogAssignment()	Tests if a course offering cataloging service is supported.
boolean	supportsCourseOfferingLookup()	Tests if looking up course offerings is supported.
boolean	supportsCourseOfferingNotification()	Tests if a course offering notification service is supported.
boolean	supportsCourseOfferingQuery()	Tests if querying course offerings is supported.
boolean	supportsCourseOfferingRecordType(Type courseOfferingRecordType)	Tests if the given CourseOffering record type is supported.
boolean	supportsCourseOfferingSearch()	Tests if searching course offerings is supported.
boolean	supportsCourseOfferingSearchRecordType(Type courseOfferingSearchRecordType)	Tests if the given CourseOffering search record type is supported.
boolean	supportsCourseOfferingSmartCourseCatalog()	Tests if a course offering smart course catalog session is available.
boolean	supportsCoursePlan()	Tests for the availability of a course plan service.
boolean	supportsCourseProgram()	Tests for the availability of a course program service.
boolean	supportsCourseQuery()	Tests if querying courses is supported.
boolean	supportsCourseRecordType(Type courseRecordType)	Tests if the given Course record type is supported.
boolean	supportsCourseRegistration()	Tests for the availability of a course registration service.
boolean	supportsCourseRequisite()	Tests for the availability of a course requisite service.
boolean	supportsCourseSearch()	Tests if searching courses is supported.
boolean	supportsCourseSearchRecordType(Type courseSearchRecordType)	Tests if the given Course search record type is supported.
boolean	supportsCourseSmartCourseCatalog()	Tests if a course smart course catalog session is available.
boolean	supportsCourseSyllabus()	Tests for the availability of a course syllabus service.
boolean	supportsTermAdmin()	Tests if term administrative service is supported.
boolean	supportsTermCourseCatalog()	Tests if a term cataloging service is supported.
boolean	supportsTermCourseCatalogAssignment()	Tests if a term cataloging service is supported.
boolean	supportsTermHierarchy()	Tests if term hierarchy traversal service is supported.
boolean	supportsTermHierarchyDesign()	Tests if a term hierarchy design service is supported.
boolean	supportsTermLookup()	Tests if looking up terms is supported.
boolean	supportsTermNotification()	Tests if a term notification service is supported.
boolean	supportsTermQuery()	Tests if querying terms is supported.
boolean	supportsTermRecordType(Type termRecordType)	Tests if the given Term record type is supported.
boolean	supportsTermSearch()	Tests if searching terms is supported.
boolean	supportsTermSearchRecordType(Type termSearchRecordType)	Tests if the given Term search record type is supported.
boolean	supportsTermSmartCourseCatalog()	Tests if a term smart course catalog session is available.
boolean	supportsVisibleFederation()	Tests if any course catalog federation is exposed.

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 OsidProxyManager

close

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

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

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

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

getCourseLookupSession

CourseLookupSession getCourseLookupSession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the course lookup service.

Parameters:

proxy - proxy

Returns:

a CourseLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseLookup()} is {@code true} .

getCourseLookupSessionForCourseCatalog

CourseLookupSession getCourseLookupSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                    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

proxy - proxy

Returns:

a CourseLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseLookup()} and {@code supportsVisibleFederation()} are {@code true}

getCourseQuerySession

CourseQuerySession getCourseQuerySession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the course query service.

Parameters:

proxy - proxy

Returns:

a CourseQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseQuery()} is {@code true} .

getCourseQuerySessionForCourseCatalog

CourseQuerySession getCourseQuerySessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CourseQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseQuery()} and {@code supportsVisibleFederation()} are {@code true}

getCourseSearchSession

CourseSearchSession getCourseSearchSession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the course search service.

Parameters:

proxy - proxy

Returns:

a CourseSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseSearch()} is {@code true} .

getCourseSearchSessionForCourseCatalog

CourseSearchSession getCourseSearchSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CourseSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseSearch()} and {@code supportsVisibleFederation()} are {@code true}

getCourseAdminSession

CourseAdminSession getCourseAdminSession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the course administration service.

Parameters:

proxy - proxy

Returns:

a CourseAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseAdmin()} is {@code true} .

getCourseAdminSessionForCourseCatalog

CourseAdminSession getCourseAdminSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CourseAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getCourseNotificationSession

CourseNotificationSession getCourseNotificationSession(CourseReceiver courseReceiver,
 Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the course notification service.

Parameters:

courseReceiver - the notification callback

proxy - proxy

Returns:

a CourseNotificationSession

Throws:

NullArgumentException - courseReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseNotification()} is {@code true} .

getCourseNotificationSessionForCourseCatalog

CourseNotificationSession getCourseNotificationSessionForCourseCatalog(CourseReceiver courseReceiver,
 Id courseCatalogId,
 Proxy proxy)
                                                                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

proxy - proxy

Returns:

a CourseNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseReceiver, courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseNotification()} and {@code supportsVisibleFederation()} are {@code true}

getCourseCourseCatalogSession

CourseCourseCatalogSession getCourseCourseCatalogSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession to lookup course/catalog mappings.

Parameters:

proxy - proxy

Returns:

a CourseCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCourseCatalog() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseCourseCatalog()} is {@code true} .

getCourseCourseCatalogAssignmentSession

CourseCourseCatalogAssignmentSession getCourseCourseCatalogAssignmentSession(Proxy proxy)
                                                                      throws OperationFailedException

Gets the OsidSession associated with assigning courses to course catalogs.

Parameters:

proxy - proxy

Returns:

a CourseCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCourseCatalogAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseCourseCatalogAssignment()} is {@code true} .

getCourseSmartCourseCatalogSession

CourseSmartCourseCatalogSession getCourseSmartCourseCatalogSession(Id courseCatalogId,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CourseSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseSmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseSmartCourseCatalog()} and {@code supportsVisibleFederation()} are {@code true}

getActivityUnitLookupSession

ActivityUnitLookupSession getActivityUnitLookupSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the activity unit lookup service.

Parameters:

proxy - proxy

Returns:

an ActivityUnitSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityUnitLookup()} is {@code true} .

getActivityUnitLookupSessionForCourseCatalog

ActivityUnitLookupSession getActivityUnitLookupSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                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

proxy - proxy

Returns:

an ActivityUnitLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityUnitLookup()} and {@code supportsVisibleFederation()} are {@code true}

getActivityUnitQuerySession

ActivityUnitQuerySession getActivityUnitQuerySession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the activity unit query service.

Parameters:

proxy - proxy

Returns:

an ActivityUnitQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityUnitQuery()} is {@code true} .

getActivityUnitQuerySessionForCourseCatalog

ActivityUnitQuerySession getActivityUnitQuerySessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                              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

proxy - proxy

Returns:

an ActivityUnitQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityUnitQuery()} and {@code supportsVisibleFederation()} are {@code true}

getActivityUnitSearchSession

ActivityUnitSearchSession getActivityUnitSearchSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the activity unit search service.

Parameters:

proxy - proxy

Returns:

an ActivityUnitSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityUnitSearch()} is {@code true} .

getActivityUnitSearchSessionForCourseCatalog

ActivityUnitSearchSession getActivityUnitSearchSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                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

proxy - proxy

Returns:

an ActivityUnitSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityUnitSearch()} and {@code supportsVisibleFederation()} are {@code true}

getActivityUnitAdminSession

ActivityUnitAdminSession getActivityUnitAdminSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the activity unit administration service.

Parameters:

proxy - proxy

Returns:

an ActivityUnitAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityUnitAdmin()} is {@code true} .

getActivityUnitAdminSessionForCourseCatalog

ActivityUnitAdminSession getActivityUnitAdminSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                              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

proxy - proxy

Returns:

an ActivityUnitAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityUnitAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getActivityUnitNotificationSession

ActivityUnitNotificationSession getActivityUnitNotificationSession(ActivityUnitReceiver activityUnitReceiver,
 Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the activity unit notification service.

Parameters:

activityUnitReceiver - the notification callback

proxy - proxy

Returns:

an ActivityUnitNotificationSession

Throws:

NullArgumentException - activityUnitReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityUnitNotification()} is {@code true} .

getActivityUnitNotificationSessionForCourseCatalog

ActivityUnitNotificationSession getActivityUnitNotificationSessionForCourseCatalog(ActivityUnitReceiver activityUnitReceiver,
 Id courseCatalogId,
 Proxy proxy)
                                                                            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

proxy - proxy

Returns:

an ActivityUnitNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - activityUnitReceiver, courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityUnitNotification()} and {@code supportsVisibleFederation()} are {@code true}

getActivityUnitCourseCatalogSession

ActivityUnitCourseCatalogSession getActivityUnitCourseCatalogSession(Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession to lookup activity unit/catalog mappings.

Parameters:

proxy - proxy

Returns:

an ActivityUnitCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitCatalog() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityUnitCatalog()} is {@code true} .

getActivityUnitCourseCatalogAssignmentSession

ActivityUnitCourseCatalogAssignmentSession getActivityUnitCourseCatalogAssignmentSession(Proxy proxy)
                                                                                  throws OperationFailedException

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

Parameters:

proxy - proxy

Returns:

an ActivityUnitCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitCatalogAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityUnitCatalogAssignment()} is {@code true} .

getActivityUnitSmartCourseCatalogSession

ActivityUnitSmartCourseCatalogSession getActivityUnitSmartCourseCatalogSession(Id courseCatalogId,
 Proxy proxy)
                                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an ActivityUnitSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnitSmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityUnitSmartCourseCatalog()} and {@code supportsVisibleFederation()} are {@code true}

getCourseOfferingLookupSession

CourseOfferingLookupSession getCourseOfferingLookupSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the course offering lookup service.

Parameters:

proxy - proxy

Returns:

a CourseOfferingSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseOfferingLookup()} is {@code true} .

getCourseOfferingLookupSessionForCourseCatalog

CourseOfferingLookupSession getCourseOfferingLookupSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                    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

proxy - proxy

Returns:

a CourseOfferingLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseOfferingLookup()} and {@code supportsVisibleFederation()} are {@code true}

getCourseOfferingQuerySession

CourseOfferingQuerySession getCourseOfferingQuerySession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the course offering query service.

Parameters:

proxy - proxy

Returns:

a CourseOfferingQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseOfferingQuery()} is {@code true} .

getCourseOfferingQuerySessionForCourseCatalog

CourseOfferingQuerySession getCourseOfferingQuerySessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                  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

proxy - proxy

Returns:

a CourseOfferingQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseOfferingQuery()} and {@code supportsVisibleFederation()} are {@code true}

getCourseOfferingSearchSession

CourseOfferingSearchSession getCourseOfferingSearchSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the course offering search service.

Parameters:

proxy - proxy

Returns:

a CourseOfferingSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseOfferingSearch()} is {@code true} .

getCourseOfferingSearchSessionForCourseCatalog

CourseOfferingSearchSession getCourseOfferingSearchSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                    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

proxy - proxy

Returns:

a CourseOfferingSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseOfferingSearch()} and {@code supportsVisibleFederation()} are {@code true}

getCourseOfferingAdminSession

CourseOfferingAdminSession getCourseOfferingAdminSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the course offering administration service.

Parameters:

proxy - proxy

Returns:

a CourseOfferingAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseOfferingAdmin()} is {@code true} .

getCourseOfferingAdminSessionForCourseCatalog

CourseOfferingAdminSession getCourseOfferingAdminSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                  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

proxy - proxy

Returns:

a CourseOfferingAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseOfferingAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getCourseOfferingNotificationSession

CourseOfferingNotificationSession getCourseOfferingNotificationSession(CourseOfferingReceiver courseOfferingReceiver,
 Proxy proxy)
                                                                throws OperationFailedException

Gets the OsidSession associated with the course offering notification service.

Parameters:

courseOfferingReceiver - the notification callback

proxy - proxy

Returns:

a CourseOfferingNotificationSession

Throws:

NullArgumentException - courseOfferingReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseOfferingNotification()} is {@code true} .

getCourseOfferingNotificationSessionForCourseCatalog

CourseOfferingNotificationSession getCourseOfferingNotificationSessionForCourseCatalog(CourseOfferingReceiver courseOfferingReceiver,
 Id courseCatalogId,
 Proxy proxy)
                                                                                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

proxy - proxy

Returns:

a CourseOfferingNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseOfferingReceiver, courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseOfferingNotification()} and {@code supportsVisibleFederation()} are {@code true}

getCourseOfferingCourseCatalogSession

CourseOfferingCourseCatalogSession getCourseOfferingCourseCatalogSession(Proxy proxy)
                                                                  throws OperationFailedException

Gets the OsidSession to lookup course offering/catalog mappings.

Parameters:

proxy - proxy

Returns:

a CourseOfferingCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingCourseCatalog() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseOfferingCourseCatalog()} is {@code true} .

getCourseOfferingCourseCatalogAssignmentSession

CourseOfferingCourseCatalogAssignmentSession getCourseOfferingCourseCatalogAssignmentSession(Proxy proxy)
                                                                                      throws OperationFailedException

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

Parameters:

proxy - proxy

Returns:

a CourseOfferingCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingCourseCatalogAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseOfferingCourseCatalogAssignment()} is {@code true} .

getCourseOfferingSmartCourseCatalogSession

CourseOfferingSmartCourseCatalogSession getCourseOfferingSmartCourseCatalogSession(Id courseCatalogId,
 Proxy proxy)
                                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CourseOfferingSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseOfferingSmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseOfferingSmartCourseCatalog()} and {@code supportsVisibleFederation()} are {@code true}

getActivityLookupSession

ActivityLookupSession getActivityLookupSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the activity lookup service.

Parameters:

proxy - proxy

Returns:

an ActivityLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityLookup()} is {@code true} .

getActivityLookupSessionForCourseCatalog

ActivityLookupSession getActivityLookupSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an ActivityLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityLookup()} and {@code supportsVisibleFederation()} are {@code true}

getActivityQuerySession

ActivityQuerySession getActivityQuerySession(Proxy proxy)
                                      throws OperationFailedException

Gets the OsidSession associated with the activity query service.

Parameters:

proxy - proxy

Returns:

an ActivityQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityQuery()} is {@code true} .

getActivityQuerySessionForCourseCatalog

ActivityQuerySession getActivityQuerySessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an ActivityQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityQuery()} and {@code supportsVisibleFederation()} are {@code true}

getActivitySearchSession

ActivitySearchSession getActivitySearchSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the activity search service.

Parameters:

proxy - proxy

Returns:

an ActivitySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivitySearch() is false

Compliance:

optional - This method must be implemented if {@code supportsActivitySearch()} is {@code true} .

getActivitySearchSessionForCourseCatalog

ActivitySearchSession getActivitySearchSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an ActivitySearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivitySearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActivitySearch()} and {@code supportsVisibleFederation()} are {@code true}

getActivityAdminSession

ActivityAdminSession getActivityAdminSession(Proxy proxy)
                                      throws OperationFailedException

Gets the OsidSession associated with the activity administration service.

Parameters:

proxy - proxy

Returns:

an ActivityAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityAdmin()} is {@code true} .

getActivityAdminSessionForCourseCatalog

ActivityAdminSession getActivityAdminSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an ActivityAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getActivityNotificationSession

ActivityNotificationSession getActivityNotificationSession(ActivityReceiver activityReceiver,
 Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the activity notification service.

Parameters:

activityReceiver - the notification callback

proxy - proxy

Returns:

an ActivityNotificationSession

Throws:

NullArgumentException - activityReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityNotification()} is {@code true} .

getActivityNotificationSessionForCourseCatalog

ActivityNotificationSession getActivityNotificationSessionForCourseCatalog(ActivityReceiver activityReceiver,
 Id courseCatalogId,
 Proxy proxy)
                                                                    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

proxy - proxy

Returns:

an ActivityNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - activityReceiver, courseCatalogId , or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityNotification()} and {@code supportsVisibleFederation()} are {@code true}

getActivityCourseCatalogSession

ActivityCourseCatalogSession getActivityCourseCatalogSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession to lookup activity/catalog mappings.

Parameters:

proxy - proxy

Returns:

an ActivityCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityCatalog() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityCatalog()} is {@code true} .

getActivityCourseCatalogAssignmentSession

ActivityCourseCatalogAssignmentSession getActivityCourseCatalogAssignmentSession(Proxy proxy)
                                                                          throws OperationFailedException

Gets the OsidSession associated with assigning activities to course catalogs.

Parameters:

proxy - proxy

Returns:

an ActivityCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityCatalogAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityCatalogAssignment()} is {@code true} .

getActivitySmartCourseCatalogSession

ActivitySmartCourseCatalogSession getActivitySmartCourseCatalogSession(Id courseCatalogId,
 Proxy proxy)
                                                                throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an ActivitySmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivitySmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActivitySmartCourseCatalog()} and {@code supportsVisibleFederation()} are {@code true}

getActivityUnravellingSession

ActivityUnravellingSession getActivityUnravellingSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with unravelling activities into meeting times.

Parameters:

proxy - proxy

Returns:

an ActivityUnravellingSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnravelling() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityUnravelling()} is {@code true} .

getActivityUnravellingSessionForCourseCatalog

ActivityUnravellingSession getActivityUnravellingSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                  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

proxy - proxy

Returns:

an ActivityUnravellingSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityUnravelling() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityUnravelling()} and {@code supportsVisibleFederation()} are {@code true}

getTermLookupSession

TermLookupSession getTermLookupSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the term lookup service.

Parameters:

proxy - proxy

Returns:

a TermLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsTermLookup()} is {@code true} .

getTermLookupSessionForCourseCatalog

TermLookupSession getTermLookupSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a TermLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsTermLookup()} and {@code supportsVisibleFederation()} are {@code true}

getTermQuerySession

TermQuerySession getTermQuerySession(Proxy proxy)
                              throws OperationFailedException

Gets the OsidSession associated with the term query service.

Parameters:

proxy - proxy

Returns:

a TermQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsTermQuery()} is {@code true} .

getTermQuerySessionForCourseCatalog

TermQuerySession getTermQuerySessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a TermQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsTermQuery()} and {@code supportsVisibleFederation()} are {@code true}

getTermSearchSession

TermSearchSession getTermSearchSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the term search service.

Parameters:

proxy - proxy

Returns:

a TermSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsTermSearch()} is {@code true} .

getTermSearchSessionForCourseCatalog

TermSearchSession getTermSearchSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a TermSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsTermSearch()} and {@code supportsVisibleFederation()} are {@code true}

getTermAdminSession

TermAdminSession getTermAdminSession(Proxy proxy)
                              throws OperationFailedException

Gets the OsidSession associated with the term administration service.

Parameters:

proxy - proxy

Returns:

a TermAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsTermAdmin()} is {@code true} .

getTermAdminSessionForCourseCatalog

TermAdminSession getTermAdminSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a TermAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsTermAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getTermNotificationSession

TermNotificationSession getTermNotificationSession(TermReceiver termReceiver,
 Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the term notification service.

Parameters:

termReceiver - the notification callback

proxy - proxy

Returns:

a TermNotificationSession

Throws:

NullArgumentException - termReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsTermNotification()} is {@code true} .

getTermNotificationSessionForCourseCatalog

TermNotificationSession getTermNotificationSessionForCourseCatalog(TermReceiver termReceiver,
 Id courseCatalogId,
 Proxy proxy)
                                                            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

proxy - proxy

Returns:

a TermNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - termReceiver, courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsTermNotification()} and {@code supportsVisibleFederation()} are {@code true}

getTermHierarchySession

TermHierarchySession getTermHierarchySession(Proxy proxy)
                                      throws OperationFailedException

Gets the term hierarchy traversal session.

Parameters:

proxy - proxy

Returns:

a TermHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsTermHierarchy()} is {@code true} .

getTermHierarchySessionForCourseCatalog

TermHierarchySession getTermHierarchySessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                      throws NotFoundException,
OperationFailedException

Gets the term hierarchy traversal session for the given catalog.

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a TermHierarchySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermHierarchy() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsTermHierarchy()} and {@code supportsVisibleFederation()} are {@code true}

getTermHierarchyDesignSession

TermHierarchyDesignSession getTermHierarchyDesignSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the term hierarchy design session.

Parameters:

proxy - proxy

Returns:

a TermHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsTermHierarchyDesign()} is {@code true} .

getTermHierarchyDesignSessionForCourseCatalog

TermHierarchyDesignSession getTermHierarchyDesignSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                  throws NotFoundException,
OperationFailedException

Gets the term hierarchy design session for the given catalog.

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a TermHierarchyDesignSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermHierarchyDesign() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsTermHierarchyDesign()} and {@code supportsVisibleFederation()} are {@code true}

getTermCourseCatalogSession

TermCourseCatalogSession getTermCourseCatalogSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession to lookup term/catalog mappings.

Parameters:

proxy - proxy

Returns:

a TermCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermCatalog() is false

Compliance:

optional - This method must be implemented if {@code supportsTermCatalog()} is {@code true} .

getTermCourseCatalogAssignmentSession

TermCourseCatalogAssignmentSession getTermCourseCatalogAssignmentSession(Proxy proxy)
                                                                  throws OperationFailedException

Gets the OsidSession associated with assigning terms to course catalogs.

Parameters:

proxy - proxy

Returns:

a TermCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermCatalogAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsTermCatalogAssignment()} is {@code true} .

getTermSmartCourseCatalogSession

TermSmartCourseCatalogSession getTermSmartCourseCatalogSession(Id courseCatalogId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a TermSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTermSmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsTermSmartCourseCatalog()} and {@code supportsVisibleFederation()} are {@code true}

getCourseCatalogLookupSession

CourseCatalogLookupSession getCourseCatalogLookupSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the course catalog lookup service.

Parameters:

proxy - proxy

Returns:

a CourseCatalogLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCatalogLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseCatalogLookup()} is {@code true} .

getCourseCatalogQuerySession

CourseCatalogQuerySession getCourseCatalogQuerySession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the course catalog query service.

Parameters:

proxy - proxy

Returns:

a CourseCatalogQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCatalogQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseCatalogQuery()} is {@code true} .

getCourseCatalogSearchSession

CourseCatalogSearchSession getCourseCatalogSearchSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the course catalog search service.

Parameters:

proxy - proxy

Returns:

a CourseCatalogSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCatalogSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseCatalogSearch()} is {@code true} .

getCourseCatalogAdminSession

CourseCatalogAdminSession getCourseCatalogAdminSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the course catalog administrative service.

Parameters:

proxy - proxy

Returns:

a CourseCatalogAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCatalogAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseCatalogAdmin()} is {@code true} .

getCourseCatalogNotificationSession

CourseCatalogNotificationSession getCourseCatalogNotificationSession(CourseCatalogReceiver courseCatalogReceiver,
 Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession associated with the course catalog notification service.

Parameters:

courseCatalogReceiver - the notification callback

proxy - proxy

Returns:

a CourseCatalogNotificationSession

Throws:

NullArgumentException - courseCatalogReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCatalogNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseCatalogNotification()} is {@code true} .

getCourseCatalogHierarchySession

CourseCatalogHierarchySession getCourseCatalogHierarchySession(Proxy proxy)
                                                        throws OperationFailedException

Gets the OsidSession associated with the course catalog hierarchy service.

Parameters:

proxy - proxy

Returns:

a CourseCatalogHierarchySession for course catalogs

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCatalogHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseCatalogHierarchy()} is {@code true} .

getCourseCatalogHierarchyDesignSession

CourseCatalogHierarchyDesignSession getCourseCatalogHierarchyDesignSession(Proxy proxy)
                                                                    throws OperationFailedException

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

Parameters:

proxy - proxy

Returns:

a HierarchyDesignSession for course catalogs

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseCatalogHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseCatalogHierarchyDesign()} is {@code true} .

getCourseBatchProxyManager

CourseBatchProxyManager getCourseBatchProxyManager()
                                            throws OperationFailedException

Gets a CourseBatchProxyManager .

Returns:

a CourseBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseBatch()} is {@code true} .

getCourseProgramProxyManager

CourseProgramProxyManager getCourseProgramProxyManager()
                                                throws OperationFailedException

Gets a CourseProgramProxyManager .

Returns:

a CourseProgramProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseProgram() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseProgram()} is {@code true} .

getCourseRegistrationProxyManager

CourseRegistrationProxyManager getCourseRegistrationProxyManager()
                                                          throws OperationFailedException

Gets a CourseRegistrationProxyManager .

Returns:

a CourseRegistrationProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRegistration() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseRegistration()} is {@code true} .

getCourseRequisiteProxyManager

CourseRequisiteProxyManager getCourseRequisiteProxyManager()
                                                    throws OperationFailedException

Gets a CourseRequisiteProxyManager .

Returns:

a CourseRequisiteProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRequisite() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseRequisite()} is {@code true} .

getCourseSyllabusProxyManager

CourseSyllabusProxyManager getCourseSyllabusProxyManager()
                                                  throws OperationFailedException

Gets a CourseSyllabusProxyManager .

Returns:

a CourseSyllabusProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseSyllabus() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseSyllabus()} is {@code true} .

getCoursePlanProxyManager

CoursePlanProxyManager getCoursePlanProxyManager()
                                          throws OperationFailedException

Gets a CoursePlanProxyManager .

Returns:

a CoursePlanProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCoursePlan() is false

Compliance:

optional - This method must be implemented if {@code supportsCoursePlan()} is {@code true} .

getCourseChronicleProxyManager

CourseChronicleProxyManager getCourseChronicleProxyManager()
                                                    throws OperationFailedException

Gets a CourseChronicleProxyManager .

Returns:

a CourseChronicleProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseChronicle() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseChronicle()} is {@code true} .