org.osid.course.registration

Interface CourseRegistrationManager

All Superinterfaces:

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

public interface CourseRegistrationManager
extends OsidManager, CourseRegistrationProfile

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

• ActivityBundleLookupSession: a session to retrieve activity bundles
• ActivityBundleQuerySession: a session to query activity bundles
• ActivityBundleSearchSession: a session to search for activity bundles
• ActivityBundleAdminSession: a session to create and delete activity bundles
• ActivityBundleNotificationSession: a session to receive notifications pertaining to activity bundle changes
• ActivityBundleCourseCatalogSession: a session to look up activity bundle to course catalog mappings
• ActivityBundleCourseCatalogAssignmentSession: a session to manage activity bundle to course catalog mappings
• ActivityBundleSmartCourseCatalogSession: a session to manage dynamic course catalogs of activity bundles

• RegistrationLookupSession: a session to retrieve registrations
• RegistrationQuerySession: a session to query registrations
• RegistrationSearchSession: a session to search for registrations
• RegistrationAdminSession: a session to create and delete registrations
• RegistrationNotificationSession: a session to receive notifications pertaining to registration changes
• RegistrationCourseCatalogSession: a session to look up registration to course catalog mappings
• RegistrationCourseCatalogAssignmentSession: a session to manage registration to course catalog mappings
• RegistrationSmartCourseCatalogSession: a session to manage dynamic course catalogs of registrations

• ActivityRegistrationLookupSession: a session to retrieve activity registrations
• ActivityRegistrationQuerySession: a session to query activity registrations
• ActivityRegistrationSearchSession: a session to search for activity registrations
• ActivityRegistrationAdminSession: a session to create and delete activity registrations
• ActivityRegistrationNotificationSession: a session to receive notifications pertaining to activity registration changes
• ActivityRegistrationCourseCatalogSession: a session to look up activity registration to course catalog mappings
• ActivityRegistrationCourseCatalogAssignmentSession: a session to manage activity registration to course catalog mappings
• ActivityRegistrationSmartCourseCatalogSession: a session to manage dynamic course catalogs of activity registrations

Method Summary

Methods

Modifier and Type	Method and Description
ActivityBundleAdminSession	getActivityBundleAdminSession() Gets the OsidSession associated with the activity bundle administration service.
ActivityBundleAdminSession	getActivityBundleAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the activity bundle administration service for the given course catalog.
ActivityBundleCourseCatalogAssignmentSession	getActivityBundleCourseCatalogAssignmentSession() Gets the OsidSession associated with assigning activity bundles to course catalogs.
ActivityBundleCourseCatalogSession	getActivityBundleCourseCatalogSession() Gets the OsidSession to lookup activity bundle/catalog mappings.
ActivityBundleLookupSession	getActivityBundleLookupSession() Gets the OsidSession associated with the activity bundle lookup service.
ActivityBundleLookupSession	getActivityBundleLookupSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the activity bundle lookup service for the given course catalog.
ActivityBundleNotificationSession	getActivityBundleNotificationSession(ActivityBundleReceiver activityBundleReceiver) Gets the OsidSession associated with the activity bundle notification service.
ActivityBundleNotificationSession	getActivityBundleNotificationSessionForCourseCatalog(ActivityBundleReceiver activityBundleReceiver, Id courseCatalogId) Gets the OsidSession associated with the activity bundle notification service for the given course catalog.
ActivityBundleQuerySession	getActivityBundleQuerySession() Gets the OsidSession associated with the activity bundle query service.
ActivityBundleQuerySession	getActivityBundleQuerySessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the activity bundle query service for the given course catalog.
ActivityBundleSearchSession	getActivityBundleSearchSession() Gets the OsidSession associated with the activity bundle search service.
ActivityBundleSearchSession	getActivityBundleSearchSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the activity bundle search service for the given course catalog.
ActivityBundleSmartCourseCatalogSession	getActivityBundleSmartCourseCatalogSession(Id courseCatalogId) Gets the OsidSession associated with the activity bundle smart course catalog service.
ActivityRegistrationAdminSession	getActivityRegistrationAdminSession() Gets the OsidSession associated with the activity registration administration service.
ActivityRegistrationAdminSession	getActivityRegistrationAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the activity registration administration service for the given course catalog.
ActivityRegistrationCourseCatalogAssignmentSession	getActivityRegistrationCourseCatalogAssignmentSession() Gets the OsidSession associated with assigning activity registrations to course catalogs.
ActivityRegistrationCourseCatalogSession	getActivityRegistrationCourseCatalogSession() Gets the OsidSession to lookup activity registration/catalog mappings.
ActivityRegistrationLookupSession	getActivityRegistrationLookupSession() Gets the OsidSession associated with the activity registration lookup service.
ActivityRegistrationLookupSession	getActivityRegistrationLookupSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the activity registration lookup service for the given course catalog.
ActivityRegistrationNotificationSession	getActivityRegistrationNotificationSession(ActivityRegistrationReceiver activityRegistrationReceiver) Gets the OsidSession associated with the activity registration notification service.
ActivityRegistrationNotificationSession	getActivityRegistrationNotificationSessionForCourseCatalog(ActivityRegistrationReceiver activityRegistrationReceiver, Id courseCatalogId) Gets the OsidSession associated with the activity registration notification service for the given course catalog.
ActivityRegistrationQuerySession	getActivityRegistrationQuerySession() Gets the OsidSession associated with the activity registration query service.
ActivityRegistrationQuerySession	getActivityRegistrationQuerySessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the activity registration query service for the given course catalog.
ActivityRegistrationSearchSession	getActivityRegistrationSearchSession() Gets the OsidSession associated with the activity registration search service.
ActivityRegistrationSearchSession	getActivityRegistrationSearchSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the activity registration search service for the given course catalog.
ActivityRegistrationSmartCourseCatalogSession	getActivityRegistrationSmartCourseCatalogSession(Id courseCatalogId) Gets the OsidSession associated with the activity registration smart course catalog service.
CourseRegistrationBatchManager	getCourseRegistrationBatchManager() Gets a CourseRegistrationBatchManager.
RegistrationAdminSession	getRegistrationAdminSession() Gets the OsidSession associated with the registration administration service.
RegistrationAdminSession	getRegistrationAdminSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the registration administration service for the given course catalog.
RegistrationCourseCatalogAssignmentSession	getRegistrationCourseCatalogAssignmentSession() Gets the OsidSession associated with assigning registrations to course catalogs.
RegistrationCourseCatalogSession	getRegistrationCourseCatalogSession() Gets the OsidSession to lookup registration/catalog mappings.
RegistrationLookupSession	getRegistrationLookupSession() Gets the OsidSession associated with the registration lookup service.
RegistrationLookupSession	getRegistrationLookupSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the registration lookup service for the given course catalog.
RegistrationNotificationSession	getRegistrationNotificationSession(RegistrationReceiver registrationReceiver) Gets the OsidSession associated with the registration notification service.
RegistrationNotificationSession	getRegistrationNotificationSessionForCourseCatalog(RegistrationReceiver registrationReceiver, Id courseCatalogId) Gets the OsidSession associated with the registration notification service for the given course catalog.
RegistrationQuerySession	getRegistrationQuerySession() Gets the OsidSession associated with the registration query service.
RegistrationQuerySession	getRegistrationQuerySessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the registration query service for the given course catalog.
RegistrationSearchSession	getRegistrationSearchSession() Gets the OsidSession associated with the registration search service.
RegistrationSearchSession	getRegistrationSearchSessionForCourseCatalog(Id courseCatalogId) Gets the OsidSession associated with the registration search service for the given course catalog.
RegistrationSmartCourseCatalogSession	getRegistrationSmartCourseCatalogSession(Id courseCatalogId) Gets the OsidSession associated with the registration smart course catalog service.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.course.registration.CourseRegistrationProfile

getActivityBundleRecordTypes, getActivityBundleSearchRecordTypes, getActivityRegistrationRecordTypes, getActivityRegistrationSearchRecordTypes, getRegistrationRecordTypes, getRegistrationSearchRecordTypes, supportsActivityBundleAdmin, supportsActivityBundleCourseCatalog, supportsActivityBundleCourseCatalogAssignment, supportsActivityBundleLookup, supportsActivityBundleNotification, supportsActivityBundleQuery, supportsActivityBundleRecordType, supportsActivityBundleSearch, supportsActivityBundleSearchRecordType, supportsActivityBundleSmartCourseCatalog, supportsActivityRegistrationAdmin, supportsActivityRegistrationCourseCatalog, supportsActivityRegistrationCourseCatalogAssignment, supportsActivityRegistrationLookup, supportsActivityRegistrationNotification, supportsActivityRegistrationQuery, supportsActivityRegistrationRecordType, supportsActivityRegistrationSearch, supportsActivityRegistrationSearchRecordType, supportsActivityRegistrationSmartCourseCatalog, supportsCourseRegistrationBatch, supportsRegistrationAdmin, supportsRegistrationCourseCatalog, supportsRegistrationCourseCatalogAssignment, supportsRegistrationLookup, supportsRegistrationNotification, supportsRegistrationQuery, supportsRegistrationRecordType, supportsRegistrationSearch, supportsRegistrationSearchRecordType, supportsRegistrationSmartCourseCatalog, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getActivityBundleLookupSession

ActivityBundleLookupSession getActivityBundleLookupSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the activity bundle lookup service.

Returns:

an ActivityBundleSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBundleLookup() is false

Compliance:

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

getActivityBundleLookupSessionForCourseCatalog

ActivityBundleLookupSession getActivityBundleLookupSessionForCourseCatalog(Id courseCatalogId)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

Returns:

an ActivityBundleLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBundleLookup() or supportsVisibleFederation() is false

Compliance:

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

getActivityBundleQuerySession

ActivityBundleQuerySession getActivityBundleQuerySession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the activity bundle query service.

Returns:

an ActivityBundleQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBundleQuery() is false

Compliance:

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

getActivityBundleQuerySessionForCourseCatalog

ActivityBundleQuerySession getActivityBundleQuerySessionForCourseCatalog(Id courseCatalogId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityBundleQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBundleQuery() or supportsVisibleFederation() is false

Compliance:

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

getActivityBundleSearchSession

ActivityBundleSearchSession getActivityBundleSearchSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the activity bundle search service.

Returns:

an ActivityBundleSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBundleSearch() is false

Compliance:

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

getActivityBundleSearchSessionForCourseCatalog

ActivityBundleSearchSession getActivityBundleSearchSessionForCourseCatalog(Id courseCatalogId)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityBundleSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBundleSearch() or supportsVisibleFederation() is false

Compliance:

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

getActivityBundleAdminSession

ActivityBundleAdminSession getActivityBundleAdminSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the activity bundle administration service.

Returns:

an ActivityBundleAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBundleAdmin() is false

Compliance:

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

getActivityBundleAdminSessionForCourseCatalog

ActivityBundleAdminSession getActivityBundleAdminSessionForCourseCatalog(Id courseCatalogId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityBundleAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBundleAdmin() or supportsVisibleFederation() is false

Compliance:

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

getActivityBundleNotificationSession

ActivityBundleNotificationSession getActivityBundleNotificationSession(ActivityBundleReceiver activityBundleReceiver)
                                                                       throws OperationFailedException

Gets the OsidSession associated with the activity bundle notification service.

Parameters:

activityBundleReceiver - the notification callback

Returns:

an ActivityBundleNotificationSession

Throws:

NullArgumentException - activityBundleReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBundleNotification() is false

Compliance:

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

getActivityBundleNotificationSessionForCourseCatalog

ActivityBundleNotificationSession getActivityBundleNotificationSessionForCourseCatalog(ActivityBundleReceiver activityBundleReceiver,
                                                                                     Id courseCatalogId)
                                                                                       throws NotFoundException,
                                                                                              OperationFailedException

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

Parameters:

activityBundleReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityBundleNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - activityBundleReceiver or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBundleNotification() or supportsVisibleFederation() is false

Compliance:

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

getActivityBundleCourseCatalogSession

ActivityBundleCourseCatalogSession getActivityBundleCourseCatalogSession()
                                                                         throws OperationFailedException

Gets the OsidSession to lookup activity bundle/catalog mappings.

Returns:

an ActivityBundleCourseCatalogSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBundleCourseCatalog() is false

Compliance:

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

getActivityBundleCourseCatalogAssignmentSession

ActivityBundleCourseCatalogAssignmentSession getActivityBundleCourseCatalogAssignmentSession()
                                                                                             throws OperationFailedException

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

Returns:

an ActivityBundleCourseCatalogAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBundleCourseCatalogAssignment() is false

Compliance:

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

getActivityBundleSmartCourseCatalogSession

ActivityBundleSmartCourseCatalogSession getActivityBundleSmartCourseCatalogSession(Id courseCatalogId)
                                                                                   throws NotFoundException,
                                                                                          OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityBundleSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBundleSmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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

getRegistrationLookupSession

RegistrationLookupSession getRegistrationLookupSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the registration lookup service.

Returns:

a RegistrationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationLookup() is false

Compliance:

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

getRegistrationLookupSessionForCourseCatalog

RegistrationLookupSession getRegistrationLookupSessionForCourseCatalog(Id courseCatalogId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

Returns:

a RegistrationLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationLookup() or supportsVisibleFederation() is false

Compliance:

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

getRegistrationQuerySession

RegistrationQuerySession getRegistrationQuerySession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the registration query service.

Returns:

a RegistrationQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationQuery() is false

Compliance:

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

getRegistrationQuerySessionForCourseCatalog

RegistrationQuerySession getRegistrationQuerySessionForCourseCatalog(Id courseCatalogId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a RegistrationQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationQuery() or supportsVisibleFederation() is false

Compliance:

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

getRegistrationSearchSession

RegistrationSearchSession getRegistrationSearchSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the registration search service.

Returns:

a RegistrationSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationSearch() is false

Compliance:

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

getRegistrationSearchSessionForCourseCatalog

RegistrationSearchSession getRegistrationSearchSessionForCourseCatalog(Id courseCatalogId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a RegistrationSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationSearch() or supportsVisibleFederation() is false

Compliance:

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

getRegistrationAdminSession

RegistrationAdminSession getRegistrationAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the registration administration service.

Returns:

a RegistrationAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationAdmin() is false

Compliance:

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

getRegistrationAdminSessionForCourseCatalog

RegistrationAdminSession getRegistrationAdminSessionForCourseCatalog(Id courseCatalogId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a RegistrationAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationAdmin() or supportsVisibleFederation() is false

Compliance:

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

getRegistrationNotificationSession

RegistrationNotificationSession getRegistrationNotificationSession(RegistrationReceiver registrationReceiver)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the registration notification service.

Parameters:

registrationReceiver - the notification callback

Returns:

a RegistrationNotificationSession

Throws:

NullArgumentException - registrationReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationNotification() is false

Compliance:

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

getRegistrationNotificationSessionForCourseCatalog

RegistrationNotificationSession getRegistrationNotificationSessionForCourseCatalog(RegistrationReceiver registrationReceiver,
                                                                                 Id courseCatalogId)
                                                                                   throws NotFoundException,
                                                                                          OperationFailedException

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

Parameters:

registrationReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

Returns:

a RegistrationNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - registrationReceiver or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationNotification() or supportsVisibleFederation() is false

Compliance:

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

getRegistrationCourseCatalogSession

RegistrationCourseCatalogSession getRegistrationCourseCatalogSession()
                                                                     throws OperationFailedException

Gets the OsidSession to lookup registration/catalog mappings.

Returns:

a RegistrationCourseCatalogSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationCourseCatalog() is false

Compliance:

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

getRegistrationCourseCatalogAssignmentSession

RegistrationCourseCatalogAssignmentSession getRegistrationCourseCatalogAssignmentSession()
                                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning registrations to course catalogs.

Returns:

a RegistrationCourseCatalogAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationCourseCatalogAssignment() is false

Compliance:

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

getRegistrationSmartCourseCatalogSession

RegistrationSmartCourseCatalogSession getRegistrationSmartCourseCatalogSession(Id courseCatalogId)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a RegistrationSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationSmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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

getActivityRegistrationLookupSession

ActivityRegistrationLookupSession getActivityRegistrationLookupSession()
                                                                       throws OperationFailedException

Gets the OsidSession associated with the activity registration lookup service.

Returns:

an ActivityRegistrationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityRegistrationLookup() is false

Compliance:

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

getActivityRegistrationLookupSessionForCourseCatalog

ActivityRegistrationLookupSession getActivityRegistrationLookupSessionForCourseCatalog(Id courseCatalogId)
                                                                                       throws NotFoundException,
                                                                                              OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

Returns:

an ActivityRegistrationLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityRegistrationLookup() or supportsVisibleFederation() is false

Compliance:

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

getActivityRegistrationQuerySession

ActivityRegistrationQuerySession getActivityRegistrationQuerySession()
                                                                     throws OperationFailedException

Gets the OsidSession associated with the activity registration query service.

Returns:

an ActivityRegistrationQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityRegistrationQuery() is false

Compliance:

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

getActivityRegistrationQuerySessionForCourseCatalog

ActivityRegistrationQuerySession getActivityRegistrationQuerySessionForCourseCatalog(Id courseCatalogId)
                                                                                     throws NotFoundException,
                                                                                            OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityRegistrationQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityRegistrationQuery() or supportsVisibleFederation() is false

Compliance:

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

getActivityRegistrationSearchSession

ActivityRegistrationSearchSession getActivityRegistrationSearchSession()
                                                                       throws OperationFailedException

Gets the OsidSession associated with the activity registration search service.

Returns:

an ActivityRegistrationSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityRegistrationSearch() is false

Compliance:

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

getActivityRegistrationSearchSessionForCourseCatalog

ActivityRegistrationSearchSession getActivityRegistrationSearchSessionForCourseCatalog(Id courseCatalogId)
                                                                                       throws NotFoundException,
                                                                                              OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityRegistrationSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityRegistrationSearch() or supportsVisibleFederation() is false

Compliance:

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

getActivityRegistrationAdminSession

ActivityRegistrationAdminSession getActivityRegistrationAdminSession()
                                                                     throws OperationFailedException

Gets the OsidSession associated with the activity registration administration service.

Returns:

an ActivityRegistrationAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityRegistrationAdmin() is false

Compliance:

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

getActivityRegistrationAdminSessionForCourseCatalog

ActivityRegistrationAdminSession getActivityRegistrationAdminSessionForCourseCatalog(Id courseCatalogId)
                                                                                     throws NotFoundException,
                                                                                            OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityRegistrationAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityRegistrationAdmin() or supportsVisibleFederation() is false

Compliance:

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

getActivityRegistrationNotificationSession

ActivityRegistrationNotificationSession getActivityRegistrationNotificationSession(ActivityRegistrationReceiver activityRegistrationReceiver)
                                                                                   throws OperationFailedException

Gets the OsidSession associated with the activity registration notification service.

Parameters:

activityRegistrationReceiver - the notification callback

Returns:

an ActivityRegistrationNotificationSession

Throws:

NullArgumentException - activityRegistrationReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityRegistrationNotification() is false

Compliance:

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

getActivityRegistrationNotificationSessionForCourseCatalog

ActivityRegistrationNotificationSession getActivityRegistrationNotificationSessionForCourseCatalog(ActivityRegistrationReceiver activityRegistrationReceiver,
                                                                                                 Id courseCatalogId)
                                                                                                   throws NotFoundException,
                                                                                                          OperationFailedException

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

Parameters:

activityRegistrationReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityRegistrationNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - activityRegistrationReceiver or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityRegistrationNotification() or supportsVisibleFederation() is false

Compliance:

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

getActivityRegistrationCourseCatalogSession

ActivityRegistrationCourseCatalogSession getActivityRegistrationCourseCatalogSession()
                                                                                     throws OperationFailedException

Gets the OsidSession to lookup activity registration/catalog mappings.

Returns:

an ActivityRegistrationCourseCatalogSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityRegistrationCourseCatalog() is false

Compliance:

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

getActivityRegistrationCourseCatalogAssignmentSession

ActivityRegistrationCourseCatalogAssignmentSession getActivityRegistrationCourseCatalogAssignmentSession()
                                                                                                         throws OperationFailedException

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

Returns:

an ActivityRegistrationCourseCatalogAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityRegistrationCourseCatalogAssignment() is false

Compliance:

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

getActivityRegistrationSmartCourseCatalogSession

ActivityRegistrationSmartCourseCatalogSession getActivityRegistrationSmartCourseCatalogSession(Id courseCatalogId)
                                                                                               throws NotFoundException,
                                                                                                      OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

an ActivityRegistrationSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityRegistrationSmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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

getCourseRegistrationBatchManager

CourseRegistrationBatchManager getCourseRegistrationBatchManager()
                                                                 throws OperationFailedException

Gets a CourseRegistrationBatchManager.

Returns:

a CourseRegistrationBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRegistrationBatch() is false

Compliance:

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