Interface CourseManager
- All Superinterfaces:
AutoCloseable, Closeable, CourseProfile, OsidManager, OsidManager, OsidProfile, Sourceable
The course manager provides access to course management sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
-
CourseLookupSession: a session to retrieve courses -
CourseQuerySession: a session to query courses -
CourseSearchSession: a session to search for courses -
CourseAdminSession: a session to create and delete courses -
CourseNotificationSession: a session to receive notifications pertaining to course changes -
CourseCourseCatalogSession: a session to look up course to course catalog mappings -
CourseCourseCatalogAssignmentSession: a session to manage course to course catalog mappings -
CourseSmartCourseCatalogSession: a session to manage dynamic course catalogs of courses
-
ActivityUnitLookupSession: a session to retrieve activity units -
ActivityUnitQuerySession: a session to query activity units -
ActivityUnitSearchSession: a session to search for activity units -
ActivityUnitAdminSession: a session to create and delete activity units -
ActivityUnitNotificationSession: a session to receive notifications pertaining to activity unit changes -
ActivityUnitCourseCatalogSession: a session to look up activity unit to course catalog mappings -
ActivityUnitCourseCatalogAssignmentSession: a session to manage activity unit to course catalog mappings -
ActivityUnitSmartCourseCatalogSession: a session to manage dynamic course catalogs of activity units
-
CourseOfferingLookupSession: a session to retrieve course offerings -
CourseOfferingQuerySession: a session to query course offerings -
CourseOfferingSearchSession: a session to search for course offerings -
CourseOfferingAdminSession: a session to create and delete course offerings -
CourseOfferingNotificationSession: a session to receive notifications pertaining to course offering changes -
CourseCatalogSession: a session to look up course to course catalog mappings -
CourseOfferingCourseCatalogSession: a session to look up course offering to course catalog mappings -
CourseOfferingCourseCatalogAssignmentSession: a session to manage course offering to course catalog mappings -
CourseOfferingSmartCourseCatalogSession: a session to manage dynamic course catalogs of course offerings
-
ActivityLookupSession: a session to retrieve activities -
ActivityLookupSession: a session to query activities -
ActivitySearchSession: a session to search for activities -
ActivityAdminSession: a session to create and delete activities -
ActivityNotificationSession: a session to receive notifications pertaining to activity changes -
ActivityCourseCatalogSession: a session to look up activity to course catalog mappings -
ActivityCourseCatalogAssignmentSession: a session to manage activity to course catalog mappings -
ActivitySmartCourseCatalogAssignmentSession: a session to manage dynamic course catalogs of activities -
ActivityUnravellingSession: a session to expand activities into meeting times
-
TermLookupSession: a session to retrieve terms -
TermLookupSession: a session to query terms -
TermSearchSession: a session to search for terms -
TermAdminSession: a session to create and delete terms -
TermNotificationSession: a session to receive notifications pertaining to term changes -
TermHierarchySession: a session to traverse a hierarchy of terms -
TermHierarchyDesignSession: a session to manage a term hierarchy -
TermCourseCatalogSession: a session to look up term to course catalog mappings -
TermCourseCatalogAssignmentSession: a session to manage term to course catalog mappings -
TermSmartCourseCatalogAssignmentSession: a session to manage dynamic course catalogs of terms
-
CourseCatalogLookupSession: a session to retrieve course catalogs -
CourseCatalogQuerySession: a session to query course catalogs -
CourseCatalogSearchSession: a session to search for course catalogs -
CourseCatalogAdminSession: a session to create and delete course catalogs -
CourseCatalogNotificationSession: a session to receive notifications pertaining to course catalog changes -
CourseCatalogHierarchySession: a session to traverse a hierarchy of course catalogs -
CourseCatalogHierarchyDesignSession: a session to manage a course catalog hierarchy
-
Method Summary
Modifier and TypeMethodDescriptionGets theOsidSessionassociated with the activity administration service.getActivityAdminSessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the activity administration service for the given course catalog.Gets theOsidSessionassociated with assigning activities to course catalogs.Gets theOsidSessionto lookup activity/catalog mappings.Gets theOsidSessionassociated with the activity lookup service.getActivityLookupSessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the activity lookup service for the given course catalog.getActivityNotificationSession(ActivityReceiver activityReceiver) Gets theOsidSessionassociated with the activity notification service.getActivityNotificationSessionForCourseCatalog(ActivityReceiver activityReceiver, Id courseCatalogId) Gets theOsidSessionassociated with the activity notification service for the given course catalog.Gets theOsidSessionassociated with the activity query service.getActivityQuerySessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the activity query service for the given course catalog.Gets theOsidSessionassociated with the activity search service.getActivitySearchSessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the activity search service for the given course catalog.getActivitySmartCourseCatalogSession(Id courseCatalogId) Gets theOsidSessionassociated with the activity smart course catalog service.Gets theOsidSessionassociated with the activity unit administration service.getActivityUnitAdminSessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the activity unit administration service for the given course catalog.Gets theOsidSessionassociated with assigning activity units to course catalogs.Gets theOsidSessionto lookup activity unit/catalog mappings.Gets theOsidSessionassociated with the activity unit lookup service.getActivityUnitLookupSessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the activity unit lookup service for the given course catalog.getActivityUnitNotificationSession(ActivityUnitReceiver activityUnitReceiver) Gets theOsidSessionassociated with the activity unit notification service.getActivityUnitNotificationSessionForCourseCatalog(ActivityUnitReceiver activityUnitReceiver, Id courseCatalogId) Gets theOsidSessionassociated with the activity unit notification service for the given course catalog.Gets theOsidSessionassociated with the activity unit query service.getActivityUnitQuerySessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the activity unit query service for the given course catalog.Gets theOsidSessionassociated with the activity unit search service.getActivityUnitSearchSessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the activity unit search service for the given course catalog.getActivityUnitSmartCourseCatalogSession(Id courseCatalogId) Gets theOsidSessionassociated with the activity unit smart course catalog service.Gets theOsidSessionassociated with unravelling activities into meeting times.getActivityUnravellingSessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with unravelling activities into meeting times for the given course catalog.Gets theOsidSessionassociated with the course administration service.getCourseAdminSessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the course administration service for the given course catalog.Gets aCourseBatchManager.Gets theOsidSessionassociated with the course catalog administrative service.Gets theOsidSessionassociated with the course catalog hierarchy design service.Gets theOsidSessionassociated with the course catalog hierarchy service.Gets theOsidSessionassociated with the course catalog lookup service.getCourseCatalogNotificationSession(CourseCatalogReceiver courseCatalogReceiver) Gets theOsidSessionassociated with the course catalog notification service.Gets theOsidSessionassociated with the course catalog query service.Gets theOsidSessionassociated with the course catalog search service.Gets aCourseChronicleManager.Gets theOsidSessionassociated with assigning courses to course catalogs.Gets theOsidSessionto lookup course/catalog mappings.Gets theOsidSessionassociated with the course lookup service.getCourseLookupSessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the course lookup service for the given course catalog.getCourseNotificationSession(CourseReceiver courseReceiver) Gets theOsidSessionassociated with the course notification service.getCourseNotificationSessionForCourseCatalog(CourseReceiver courseReceiver, Id courseCatalogId) Gets theOsidSessionassociated with the course notification service for the given course catalog.Gets theOsidSessionassociated with the course offering administration service.getCourseOfferingAdminSessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the course offering administration service for the given course catalog.Gets theOsidSessionassociated with assigning course offerings to course catalogs.Gets theOsidSessionto lookup course offering/catalog mappings.Gets theOsidSessionassociated with the course offering lookup service.getCourseOfferingLookupSessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the course offering lookup service for the given course catalog.getCourseOfferingNotificationSession(CourseOfferingReceiver courseOfferingReceiver) Gets theOsidSessionassociated with the course offering notification service.getCourseOfferingNotificationSessionForCourseCatalog(CourseOfferingReceiver courseOfferingReceiver, Id courseCatalogId) Gets theOsidSessionassociated with the course offering notification service for the given course catalog.Gets theOsidSessionassociated with the course offering query service.getCourseOfferingQuerySessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the course offering query service for the given course catalog.Gets theOsidSessionassociated with the course offering search service.getCourseOfferingSearchSessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the course offering search service for the given course catalog.getCourseOfferingSmartCourseCatalogSession(Id courseCatalogId) Gets theOsidSessionassociated with the course offering smart course catalog service.Gets aCoursePlanManager.Gets aCourseProgramManager.Gets theOsidSessionassociated with the course query service.getCourseQuerySessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the course query service for the given course catalog.Gets aCourseRegistrationManager.Gets aCourseRequisiteManager.Gets theOsidSessionassociated with the course search service.getCourseSearchSessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the course search service for the given course catalog.getCourseSmartCourseCatalogSession(Id courseCatalogId) Gets theOsidSessionassociated with the course smart course catalog service.Gets aCourseSyllabusManager.Gets theOsidSessionassociated with the term administration service.getTermAdminSessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the term administration service for the given course catalog.Gets theOsidSessionassociated with assigning terms to course catalogs.Gets theOsidSessionto lookup term/catalog mappings.Gets the term hierarchy design session.getTermHierarchyDesignSessionForCourseCatalog(Id courseCatalogId) Gets the term hierarchy design session for the given course catalog.Gets the term hierarchy traversal session.getTermHierarchySessionForCourseCatalog(Id courseCatalogId) Gets the term hierarchy traversal session for the given course catalog.Gets theOsidSessionassociated with the term lookup service.getTermLookupSessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the term lookup service for the given course catalog.getTermNotificationSession(TermReceiver termReceiver) Gets theOsidSessionassociated with the term notification service.getTermNotificationSessionForCourseCatalog(TermReceiver termReceiver, Id courseCatalogId) Gets theOsidSessionassociated with the term notification service for the given course catalog.Gets theOsidSessionassociated with the term query service.getTermQuerySessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the term query service for the given course catalog.Gets theOsidSessionassociated with the term search service.getTermSearchSessionForCourseCatalog(Id courseCatalogId) Gets theOsidSessionassociated with the term search service for the given course catalog.getTermSmartCourseCatalogSession(Id courseCatalogId) Gets theOsidSessionassociated with the term smart course catalog service.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, supportsVisibleFederationModifier and TypeMethodDescriptionGets the supportedActivityrecord types.Gets the supportedActivitysearch record types.Gets the supportedActivityUnitrecord types.Gets the supportedActivityUnitsearch record types.Gets the supportedCourseCatalogrecord types.Gets the supportedCourseCatalogsearch record types.Gets the supportedCourseOfferingrecord types.Gets the supportedCourseOfferingsearch record types.Gets the supportedCourserecord types.Gets the supportedCoursesearch record types.Gets the supportedTermrecord types.Gets the supportedTermsearch record types.booleanTests if activity administrative service is supported.booleanTests if an activity cataloging service is supported.booleanTests if an activity cataloging service is supported.booleanTests if looking up activities is supported.booleanTests if an activity notification service is supported.booleanTests if querying activities is supported.booleansupportsActivityRecordType(Type activityRecordType) Tests if the givenActivityrecord type is supported.booleanTests if searching activities is supported.booleansupportsActivitySearchRecordType(Type activitySearchRecordType) Tests if the givenActivitysearch record type is supported.booleanTests if an activity smart course catalog session is available.booleanTests if an activity unit administrative service is supported.booleanTests if an activity unit cataloging service is supported.booleanTests if an activity unit cataloging service is supported.booleanTests if looking up activity units is supported.booleanTests if an activity unit notification service is supported.booleanTests if querying activity units is supported.booleansupportsActivityUnitRecordType(Type activityUnitRecordType) Tests if the givenActivityUnitrecord type is supported.booleanTests if searching activity units is supported.booleansupportsActivityUnitSearchRecordType(Type activityUnitSearchRecordType) Tests if the givenActivityUnitsearch record type is supported.booleanTests if an activity unit smart course catalog session is available.booleanTests if unravelling activities is supported.booleanTests if course administrative service is supported.booleanTests for the availability of a course batch service.booleanTests if course catalog administrative service is supported.booleanTests for the availability of a course catalog hierarchy traversal service.booleanTests for the availability of a course catalog hierarchy design service.booleanTests if looking up course catalogs is supported.booleanTests if a course catalog notification service is supported.booleanTests if querying course catalogs is supported.booleansupportsCourseCatalogRecordType(Type courseCatalogRecordType) Tests if the givenCourseCatalogrecord type is supported.booleanTests if searching course catalogs is supported.booleansupportsCourseCatalogSearchRecordType(Type courseCatalogSearchRecordType) Tests if the givenCourseCatalogsearch record type is supported.booleanTests for the availability of a course chronicle service.booleanTests if a course cataloging service is supported.booleanTests if a course cataloging service is supported.booleanTests if looking up courses is supported.booleanTests if a course notification service is supported.booleanTests if course offering administrative service is supported.booleanTests if a course offering cataloging service is supported.booleanTests if a course offering cataloging service is supported.booleanTests if looking up course offerings is supported.booleanTests if a course offering notification service is supported.booleanTests if querying course offerings is supported.booleansupportsCourseOfferingRecordType(Type courseOfferingRecordType) Tests if the givenCourseOfferingrecord type is supported.booleanTests if searching course offerings is supported.booleansupportsCourseOfferingSearchRecordType(Type courseOfferingSearchRecordType) Tests if the givenCourseOfferingsearch record type is supported.booleanTests if a course offering smart course catalog session is available.booleanTests for the availability of a course plan service.booleanTests for the availability of a course program service.booleanTests if querying courses is supported.booleansupportsCourseRecordType(Type courseRecordType) Tests if the givenCourserecord type is supported.booleanTests for the availability of a course registration service.booleanTests for the availability of a course requisite service.booleanTests if searching courses is supported.booleansupportsCourseSearchRecordType(Type courseSearchRecordType) Tests if the givenCoursesearch record type is supported.booleanTests if a course smart course catalog session is available.booleanTests for the availability of a course syllabus service.booleanTests if term administrative service is supported.booleanTests if a term cataloging service is supported.booleanTests if a term cataloging service is supported.booleanTests if term hierarchy traversal service is supported.booleanTests if a term hierarchy design service is supported.booleanTests if looking up terms is supported.booleanTests if a term notification service is supported.booleanTests if querying terms is supported.booleansupportsTermRecordType(Type termRecordType) Tests if the givenTermrecord type is supported.booleanTests if searching terms is supported.booleansupportsTermSearchRecordType(Type termSearchRecordType) Tests if the givenTermsearch record type is supported.booleanTests if a term smart course catalog session is available.booleanTests if any course catalog federation is exposed.Methods inherited from interface OsidManager
closeMethods inherited from interface OsidManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime) Rolls back this service to a point in time.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
getCourseLookupSession
Gets theOsidSessionassociated with the course lookup service.- Returns:
- a
CourseLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseLookup()} is {@code true} .
-
getCourseLookupSessionForCourseCatalog
CourseLookupSession getCourseLookupSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the course lookup service for the given course catalog.- Parameters:
courseCatalogId- theIdof the course catalog- Returns:
- a
CourseLookupSession - Throws:
NotFoundException- noCourseCatalogfound by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCourseLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getCourseQuerySession
Gets theOsidSessionassociated with the course query service.- Returns:
- a
CourseQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseQuery()} is {@code true} .
-
getCourseQuerySessionForCourseCatalog
CourseQuerySession getCourseQuerySessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the course query service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- a
CourseQuerySession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCourseQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getCourseSearchSession
Gets theOsidSessionassociated with the course search service.- Returns:
- a
CourseSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseSearch()} is {@code true} .
-
getCourseSearchSessionForCourseCatalog
CourseSearchSession getCourseSearchSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the course search service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- a
CourseSearchSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCourseSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getCourseAdminSession
Gets theOsidSessionassociated with the course administration service.- Returns:
- a
CourseAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseAdmin()} is {@code true} .
-
getCourseAdminSessionForCourseCatalog
CourseAdminSession getCourseAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the course administration service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- a
CourseAdminSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCourseAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getCourseNotificationSession
CourseNotificationSession getCourseNotificationSession(CourseReceiver courseReceiver) throws OperationFailedException Gets theOsidSessionassociated with the course notification service.- Parameters:
courseReceiver- the notification callback- Returns:
- a
CourseNotificationSession - Throws:
NullArgumentException-courseReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCourseNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseNotification()} is {@code true} .
-
getCourseNotificationSessionForCourseCatalog
CourseNotificationSession getCourseNotificationSessionForCourseCatalog(CourseReceiver courseReceiver, Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the course notification service for the given course catalog.- Parameters:
courseReceiver- the notification callbackcourseCatalogId- theIdof theCourseCatalog- Returns:
- a
CourseNotificationSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseReceiverorcourseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCourseNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getCourseCourseCatalogSession
Gets theOsidSessionto lookup course/catalog mappings.- Returns:
- a
CourseCourseCourseCatalogSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseCourseCatalog()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseCourseCatalog()} is {@code true} .
-
getCourseCourseCatalogAssignmentSession
CourseCourseCatalogAssignmentSession getCourseCourseCatalogAssignmentSession() throws OperationFailedExceptionGets theOsidSessionassociated with assigning courses to course catalogs.- Returns:
- a
CourseCourseCatalogAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseCourseCatalogAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseCourseCatalogAssignment()} is {@code true} .
-
getCourseSmartCourseCatalogSession
CourseSmartCourseCatalogSession getCourseSmartCourseCatalogSession(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the course smart course catalog service.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- a
CourseSmartCourseCatalogSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCourseSmartCourseCatalog()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseSmartCourseCatalog()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivityUnitLookupSession
Gets theOsidSessionassociated with the activity unit lookup service.- Returns:
- an
ActivityUnitSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityUnitLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityUnitLookup()} is {@code true} .
-
getActivityUnitLookupSessionForCourseCatalog
ActivityUnitLookupSession getActivityUnitLookupSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity unit lookup service for the given course catalog.- Parameters:
courseCatalogId- theIdof the course catalog- Returns:
- an
ActivityUnitLookupSession - Throws:
NotFoundException- noCourseCatalogfound by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivityUnitLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityUnitLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivityUnitQuerySession
Gets theOsidSessionassociated with the activity unit query service.- Returns:
- an
ActivityUnitQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityUnitQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityUnitQuery()} is {@code true} .
-
getActivityUnitQuerySessionForCourseCatalog
ActivityUnitQuerySession getActivityUnitQuerySessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity unit query service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- an
ActivityUnitQuerySession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivityUnitQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityUnitQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivityUnitSearchSession
Gets theOsidSessionassociated with the activity unit search service.- Returns:
- an
ActivityUnitSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityUnitSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityUnitSearch()} is {@code true} .
-
getActivityUnitSearchSessionForCourseCatalog
ActivityUnitSearchSession getActivityUnitSearchSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity unit search service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- an
ActivityUnitSearchSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivityUnitSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityUnitSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivityUnitAdminSession
Gets theOsidSessionassociated with the activity unit administration service.- Returns:
- an
ActivityUnitAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityUnitAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityUnitAdmin()} is {@code true} .
-
getActivityUnitAdminSessionForCourseCatalog
ActivityUnitAdminSession getActivityUnitAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity unit administration service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- an
ActivityUnitAdminSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivityUnitAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityUnitAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivityUnitNotificationSession
ActivityUnitNotificationSession getActivityUnitNotificationSession(ActivityUnitReceiver activityUnitReceiver) throws OperationFailedException Gets theOsidSessionassociated with the activity unit notification service.- Parameters:
activityUnitReceiver- the notification callback- Returns:
- an
ActivityUnitNotificationSession - Throws:
NullArgumentException-activityUnitReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivityUnitNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityUnitNotification()} is {@code true} .
-
getActivityUnitNotificationSessionForCourseCatalog
ActivityUnitNotificationSession getActivityUnitNotificationSessionForCourseCatalog(ActivityUnitReceiver activityUnitReceiver, Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity unit notification service for the given course catalog.- Parameters:
activityUnitReceiver- the notification callbackcourseCatalogId- theIdof theCourseCatalog- Returns:
- an
ActivityUnitNotificationSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-activityUnitReceiverorcourseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivityUnitNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityUnitNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivityUnitCourseCatalogSession
ActivityUnitCourseCatalogSession getActivityUnitCourseCatalogSession() throws OperationFailedExceptionGets theOsidSessionto lookup activity unit/catalog mappings.- Returns:
- an
ActivityUnitCourseCatalogSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityUnitCourseCatalog()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityUnitCourseCatalog()} is {@code true} .
-
getActivityUnitCourseCatalogAssignmentSession
ActivityUnitCourseCatalogAssignmentSession getActivityUnitCourseCatalogAssignmentSession() throws OperationFailedExceptionGets theOsidSessionassociated with assigning activity units to course catalogs.- Returns:
- an
ActivityUnitCourseCatalogAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityUnitCourseCatalogAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityUnitCourseCatalogAssignment()} is {@code true} .
-
getActivityUnitSmartCourseCatalogSession
ActivityUnitSmartCourseCatalogSession getActivityUnitSmartCourseCatalogSession(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity unit smart course catalog service.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- an
ActivityUnitSmartCourseCatalogSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivityUnitSmartCourseCatalog()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityUnitSmartCourseCatalog()} and {@code supportsVisibleFederation()} are {@code true}
-
getCourseOfferingLookupSession
Gets theOsidSessionassociated with the course offering lookup service.- Returns:
- a
CourseOfferingSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseOfferingLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseOfferingLookup()} is {@code true} .
-
getCourseOfferingLookupSessionForCourseCatalog
CourseOfferingLookupSession getCourseOfferingLookupSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the course offering lookup service for the given course catalog.- Parameters:
courseCatalogId- theIdof the course catalog- Returns:
- a
CourseOfferingLookupSession - Throws:
NotFoundException- noCourseCatalogfound by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCourseOfferingLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseOfferingLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getCourseOfferingQuerySession
Gets theOsidSessionassociated with the course offering query service.- Returns:
- a
CourseOfferingQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseOfferingQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseOfferingQuery()} is {@code true} .
-
getCourseOfferingQuerySessionForCourseCatalog
CourseOfferingQuerySession getCourseOfferingQuerySessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the course offering query service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- a
CourseOfferingQuerySession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCourseOfferingQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseOfferingQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getCourseOfferingSearchSession
Gets theOsidSessionassociated with the course offering search service.- Returns:
- a
CourseOfferingSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseOfferingSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseOfferingSearch()} is {@code true} .
-
getCourseOfferingSearchSessionForCourseCatalog
CourseOfferingSearchSession getCourseOfferingSearchSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the course offering search service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- a
CourseOfferingSearchSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCourseOfferingSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseOfferingSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getCourseOfferingAdminSession
Gets theOsidSessionassociated with the course offering administration service.- Returns:
- a
CourseOfferingAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseOfferingAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseOfferingAdmin()} is {@code true} .
-
getCourseOfferingAdminSessionForCourseCatalog
CourseOfferingAdminSession getCourseOfferingAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the course offering administration service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- a
CourseOfferingAdminSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCourseOfferingAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseOfferingAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getCourseOfferingNotificationSession
CourseOfferingNotificationSession getCourseOfferingNotificationSession(CourseOfferingReceiver courseOfferingReceiver) throws OperationFailedException Gets theOsidSessionassociated with the course offering notification service.- Parameters:
courseOfferingReceiver- the notification callback- Returns:
- a
CourseOfferingNotificationSession - Throws:
NullArgumentException-courseOfferingReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCourseOfferingNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseOfferingNotification()} is {@code true} .
-
getCourseOfferingNotificationSessionForCourseCatalog
CourseOfferingNotificationSession getCourseOfferingNotificationSessionForCourseCatalog(CourseOfferingReceiver courseOfferingReceiver, Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the course offering notification service for the given course catalog.- Parameters:
courseOfferingReceiver- the notification callbackcourseCatalogId- theIdof theCourseCatalog- Returns:
- a
CourseOfferingNotificationSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseOfferingReceiverorcourseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCourseOfferingNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseOfferingNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getCourseOfferingCourseCatalogSession
CourseOfferingCourseCatalogSession getCourseOfferingCourseCatalogSession() throws OperationFailedExceptionGets theOsidSessionto lookup course offering/catalog mappings.- Returns:
- a
CourseOfferingCourseCatalogSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseOfferingCourseCatalog()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseOfferingCourseCatalog()} is {@code true} .
-
getCourseOfferingCourseCatalogAssignmentSession
CourseOfferingCourseCatalogAssignmentSession getCourseOfferingCourseCatalogAssignmentSession() throws OperationFailedExceptionGets theOsidSessionassociated with assigning course offerings to course catalogs.- Returns:
- a
CourseOfferingCourseCatalogAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseOfferingCourseCatalogAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseOfferingCourseCatalogAssignment()} is {@code true} .
-
getCourseOfferingSmartCourseCatalogSession
CourseOfferingSmartCourseCatalogSession getCourseOfferingSmartCourseCatalogSession(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the course offering smart course catalog service.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- a
CourseOfferingSmartCourseCatalogSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCourseOfferingSmartCourseCatalog()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseOfferingSmartCourseCatalog()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivityLookupSession
Gets theOsidSessionassociated with the activity lookup service.- Returns:
- an
ActivityLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityLookup()} is {@code true} .
-
getActivityLookupSessionForCourseCatalog
ActivityLookupSession getActivityLookupSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity lookup service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- an
ActivityLookupSession - Throws:
NotFoundException- noCourseCatalogfound by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivityLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivityQuerySession
Gets theOsidSessionassociated with the activity query service.- Returns:
- an
ActivityQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityQuery()} is {@code true} .
-
getActivityQuerySessionForCourseCatalog
ActivityQuerySession getActivityQuerySessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity query service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- an
ActivityQuerySession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivityQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivitySearchSession
Gets theOsidSessionassociated with the activity search service.- Returns:
- an
ActivitySearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivitySearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivitySearch()} is {@code true} .
-
getActivitySearchSessionForCourseCatalog
ActivitySearchSession getActivitySearchSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity search service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- an
ActivitySearchSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivitySearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivitySearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivityAdminSession
Gets theOsidSessionassociated with the activity administration service.- Returns:
- an
ActivityAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityAdmin()} is {@code true} .
-
getActivityAdminSessionForCourseCatalog
ActivityAdminSession getActivityAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity administration service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- an
ActivityAdminSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivityAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivityNotificationSession
ActivityNotificationSession getActivityNotificationSession(ActivityReceiver activityReceiver) throws OperationFailedException Gets theOsidSessionassociated with the activity notification service.- Parameters:
activityReceiver- the notification callback- Returns:
- an
ActivityNotificationSession - Throws:
NullArgumentException-activityReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivityNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityNotification()} is {@code true} .
-
getActivityNotificationSessionForCourseCatalog
ActivityNotificationSession getActivityNotificationSessionForCourseCatalog(ActivityReceiver activityReceiver, Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity notification service for the given course catalog.- Parameters:
activityReceiver- the notification callbackcourseCatalogId- theIdof theCourseCatalog- Returns:
- an
ActivityNotificationSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-activityReceiverorcourseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivityNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivityCourseCatalogSession
Gets theOsidSessionto lookup activity/catalog mappings.- Returns:
- an
ActivityCourseCatalogSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityCourseCatalog()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityCourseCatalog()} is {@code true} .
-
getActivityCourseCatalogAssignmentSession
ActivityCourseCatalogAssignmentSession getActivityCourseCatalogAssignmentSession() throws OperationFailedExceptionGets theOsidSessionassociated with assigning activities to course catalogs.- Returns:
- an
ActivityCourseCatalogAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityCourseCatalogAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityCourseCatalogAssignment()} is {@code true} .
-
getActivitySmartCourseCatalogSession
ActivitySmartCourseCatalogSession getActivitySmartCourseCatalogSession(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity smart course catalog service.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- an
ActivitySmartCourseCatalogSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivitySmartCourseCatalog()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivitySmartCourseCatalog()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivityUnravellingSession
Gets theOsidSessionassociated with unravelling activities into meeting times.- Returns:
- an
ActivityUnravellingSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityUnravelling()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityUnravelling()} is {@code true} .
-
getActivityUnravellingSessionForCourseCatalog
ActivityUnravellingSession getActivityUnravellingSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with unravelling activities into meeting times for the given course catalog.- Parameters:
courseCatalogId- theIdof the course catalog- Returns:
- an
ActivityUnravellingSession - Throws:
NotFoundException- noCourseCatalogfound by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivityUnravelling()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityUnravelling()} and {@code supportsVisibleFederation()} are {@code true}
-
getTermLookupSession
Gets theOsidSessionassociated with the term lookup service.- Returns:
- a
TermLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsTermLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTermLookup()} is {@code true} .
-
getTermLookupSessionForCourseCatalog
TermLookupSession getTermLookupSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the term lookup service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- a
TermLookupSession - Throws:
NotFoundException- noCourseCatalogfound by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTermLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTermLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getTermQuerySession
Gets theOsidSessionassociated with the term query service.- Returns:
- a
TermQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsTermQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTermQuery()} is {@code true} .
-
getTermQuerySessionForCourseCatalog
TermQuerySession getTermQuerySessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the term query service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- a
TermQuerySession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTermQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTermQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getTermSearchSession
Gets theOsidSessionassociated with the term search service.- Returns:
- a
TermSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsTermSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTermSearch()} is {@code true} .
-
getTermSearchSessionForCourseCatalog
TermSearchSession getTermSearchSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the term search service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- a
TermSearchSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTermSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTermSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getTermAdminSession
Gets theOsidSessionassociated with the term administration service.- Returns:
- a
TermAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsTermAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTermAdmin()} is {@code true} .
-
getTermAdminSessionForCourseCatalog
TermAdminSession getTermAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the term administration service for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- a
TermAdminSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTermAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTermAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getTermNotificationSession
TermNotificationSession getTermNotificationSession(TermReceiver termReceiver) throws OperationFailedException Gets theOsidSessionassociated with the term notification service.- Parameters:
termReceiver- the notification callback- Returns:
- a
TermNotificationSession - Throws:
NullArgumentException-termReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTermNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTermNotification()} is {@code true} .
-
getTermNotificationSessionForCourseCatalog
TermNotificationSession getTermNotificationSessionForCourseCatalog(TermReceiver termReceiver, Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the term notification service for the given course catalog.- Parameters:
termReceiver- the notification callbackcourseCatalogId- theIdof theCourseCatalog- Returns:
- a
TermNotificationSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-termReceiverorcourseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTermNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTermNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getTermHierarchySession
Gets the term hierarchy traversal session.- Returns:
- a
TermHierarchySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsTermHierarchy()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTermHierarchy()} is {@code true} .
-
getTermHierarchySessionForCourseCatalog
TermHierarchySession getTermHierarchySessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets the term hierarchy traversal session for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- a
TermHierarchySession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTermHierarchy()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTermHierarchy()} and {@code supportsVisibleFederation()} are {@code true}
-
getTermHierarchyDesignSession
Gets the term hierarchy design session.- Returns:
- a
TermHierarchyDesignSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsTermHierarchyDesign()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTermHierarchyDesign()} is {@code true} .
-
getTermHierarchyDesignSessionForCourseCatalog
TermHierarchyDesignSession getTermHierarchyDesignSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets the term hierarchy design session for the given course catalog.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- a
TermHierarchyDesignSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTermHierarchyDesign()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTermHierarchyDesign()} and {@code supportsVisibleFederation()} are {@code true}
-
getTermCourseCatalogSession
Gets theOsidSessionto lookup term/catalog mappings.- Returns:
- a
TermCourseCatalogSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsTermCourseCatalog()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTermCourseCatalog()} is {@code true} .
-
getTermCourseCatalogAssignmentSession
TermCourseCatalogAssignmentSession getTermCourseCatalogAssignmentSession() throws OperationFailedExceptionGets theOsidSessionassociated with assigning terms to course catalogs.- Returns:
- a
TermCourseCatalogAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsTermCourseCatalogAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTermCourseCatalogAssignment()} is {@code true} .
-
getTermSmartCourseCatalogSession
TermSmartCourseCatalogSession getTermSmartCourseCatalogSession(Id courseCatalogId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the term smart course catalog service.- Parameters:
courseCatalogId- theIdof theCourseCatalog- Returns:
- a
TermSmartCourseCatalogSession - Throws:
NotFoundException- no course catalog found by the givenIdNullArgumentException-courseCatalogIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsTermSmartCourseCatalog()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTermSmartCourseCatalog()} and {@code supportsVisibleFederation()} are {@code true}
-
getCourseCatalogLookupSession
Gets theOsidSessionassociated with the course catalog lookup service.- Returns:
- a
CourseCatalogLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseCatalogLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseCatalogLookup()} is {@code true} .
-
getCourseCatalogQuerySession
Gets theOsidSessionassociated with the course catalog query service.- Returns:
- a
CourseCatalogQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseCatalogQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseCatalogQuery()} is {@code true} .
-
getCourseCatalogSearchSession
Gets theOsidSessionassociated with the course catalog search service.- Returns:
- a
CourseCatalogSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseCatalogSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseCatalogSearch()} is {@code true} .
-
getCourseCatalogAdminSession
Gets theOsidSessionassociated with the course catalog administrative service.- Returns:
- a
CourseCatalogAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseCatalogAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseCatalogAdmin()} is {@code true} .
-
getCourseCatalogNotificationSession
CourseCatalogNotificationSession getCourseCatalogNotificationSession(CourseCatalogReceiver courseCatalogReceiver) throws OperationFailedException Gets theOsidSessionassociated with the course catalog notification service.- Parameters:
courseCatalogReceiver- the notification callback- Returns:
- a
CourseCatalogNotificationSession - Throws:
NullArgumentException-courseCatalogReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCourseCatalogNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseCatalogNotification()} is {@code true} .
-
getCourseCatalogHierarchySession
Gets theOsidSessionassociated with the course catalog hierarchy service.- Returns:
- a
CourseCatalogHierarchySessionfor course catalogs - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseCatalogHierarchy()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseCatalogHierarchy()} is {@code true} .
-
getCourseCatalogHierarchyDesignSession
CourseCatalogHierarchyDesignSession getCourseCatalogHierarchyDesignSession() throws OperationFailedExceptionGets theOsidSessionassociated with the course catalog hierarchy design service.- Returns:
- a
HierarchyDesignSessionfor course catalogs - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseCatalogHierarchyDesign()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseCatalogHierarchyDesign()} is {@code true} .
-
getCourseBatchManager
Gets aCourseBatchManager.- Returns:
- a
CourseBatchManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseBatch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseBatch()} is {@code true} .
-
getCourseProgramManager
Gets aCourseProgramManager.- Returns:
- a
CourseProgramManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseProgram()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseProgram()} is {@code true} .
-
getCourseRegistrationManager
Gets aCourseRegistrationManager.- Returns:
- a
CourseRegistrationManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseRegistration()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseRegistration()} is {@code true} .
-
getCourseRequisiteManager
Gets aCourseRequisiteManager.- Returns:
- a
CourseRequisiteManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseRequisite()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseRequisite()} is {@code true} .
-
getCourseSyllabusManager
Gets aCourseSyllabusManager.- Returns:
- a
CourseSyllabusManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseSyllabus()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseSyllabus()} is {@code true} .
-
getCoursePlanManager
Gets aCoursePlanManager.- Returns:
- a
CoursePlanManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCoursePlan()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCoursePlan()} is {@code true} .
-
getCourseChronicleManager
Gets aCourseChronicleManager.- Returns:
- a
CourseChronicleManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCourseChronicle()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCourseChronicle()} is {@code true} .
-