org.osid.course.registration

Interface CourseRegistrationProxyManager

All Superinterfaces:

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

public interface CourseRegistrationProxyManager
extends OsidProxyManager, CourseRegistrationProfile

The course registration manager provides access to registration sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object for the purposes of passing information within a server application environment. 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(Proxy proxy) Gets the OsidSession associated with the activity bundle administration service.
ActivityBundleAdminSession	getActivityBundleAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the activity bundle administration service for the given course catalog.
ActivityBundleCourseCatalogAssignmentSession	getActivityBundleCourseCatalogAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning activity bundles to course catalogs.
ActivityBundleCourseCatalogSession	getActivityBundleCourseCatalogSession(Proxy proxy) Gets the OsidSession to lookup activity bundle/course catalog mappings.
ActivityBundleLookupSession	getActivityBundleLookupSession(Proxy proxy) Gets the OsidSession associated with the activity bundle lookup service.
ActivityBundleLookupSession	getActivityBundleLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the activity bundle lookup service for the given course catalog.
ActivityBundleNotificationSession	getActivityBundleNotificationSession(ActivityBundleReceiver activityBundleReceiver, Proxy proxy) Gets the OsidSession associated with the activity bundle notification service.
ActivityBundleNotificationSession	getActivityBundleNotificationSessionForCourseCatalog(ActivityBundleReceiver activityBundleReceiver, Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the activity bundle notification service for the given course catalog.
ActivityBundleQuerySession	getActivityBundleQuerySession(Proxy proxy) Gets the OsidSession associated with the activity bundle query service.
ActivityBundleQuerySession	getActivityBundleQuerySessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the activity bundle query service for the given course catalog.
ActivityBundleSearchSession	getActivityBundleSearchSession(Proxy proxy) Gets the OsidSession associated with the activity bundle search service.
ActivityBundleSearchSession	getActivityBundleSearchSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the activity bundle search service for the given course catalog.
ActivityBundleSmartCourseCatalogSession	getActivityBundleSmartCourseCatalogSession(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the activity bundle smart course catalog service.
ActivityRegistrationAdminSession	getActivityRegistrationAdminSession(Proxy proxy) Gets the OsidSession associated with the activity registration administration service.
ActivityRegistrationAdminSession	getActivityRegistrationAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the activity registration administration service for the given course catalog.
ActivityRegistrationCourseCatalogAssignmentSession	getActivityRegistrationCourseCatalogAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning activity registrations to course catalogs.
ActivityRegistrationCourseCatalogSession	getActivityRegistrationCourseCatalogSession(Proxy proxy) Gets the OsidSession to lookup activity registration/course catalog mappings.
ActivityRegistrationLookupSession	getActivityRegistrationLookupSession(Proxy proxy) Gets the OsidSession associated with the activity registration lookup service.
ActivityRegistrationLookupSession	getActivityRegistrationLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the activity registration lookup service for the given course catalog.
ActivityRegistrationNotificationSession	getActivityRegistrationNotificationSession(ActivityRegistrationReceiver activityRegistrationReceiver, Proxy proxy) Gets the OsidSession associated with the activity registration notification service.
ActivityRegistrationNotificationSession	getActivityRegistrationNotificationSessionForCourseCatalog(ActivityRegistrationReceiver activityRegistrationReceiver, Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the activity registration notification service for the given course catalog.
ActivityRegistrationQuerySession	getActivityRegistrationQuerySession(Proxy proxy) Gets the OsidSession associated with the activity registration query service.
ActivityRegistrationQuerySession	getActivityRegistrationQuerySessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the activity registration query service for the given course catalog.
ActivityRegistrationSearchSession	getActivityRegistrationSearchSession(Proxy proxy) Gets the OsidSession associated with the activity registration search service.
ActivityRegistrationSearchSession	getActivityRegistrationSearchSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the activity registration search service for the given course catalog.
ActivityRegistrationSmartCourseCatalogSession	getActivityRegistrationSmartCourseCatalogSession(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the activity registration smart course catalog service.
CourseRegistrationBatchProxyManager	getCourseRegistrationBatchProxyManager() Gets a CourseRegistrationBatchProxyManager.
RegistrationAdminSession	getRegistrationAdminSession(Proxy proxy) Gets the OsidSession associated with the registration administration service.
RegistrationAdminSession	getRegistrationAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the registration administration service for the given course catalog.
RegistrationCourseCatalogAssignmentSession	getRegistrationCourseCatalogAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning registrations to course catalogs.
RegistrationCourseCatalogSession	getRegistrationCourseCatalogSession(Proxy proxy) Gets the OsidSession to lookup registration/catalog mappings.
RegistrationLookupSession	getRegistrationLookupSession(Proxy proxy) Gets the OsidSession associated with the registration lookup service.
RegistrationLookupSession	getRegistrationLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the registration lookup service for the given course catalog.
RegistrationNotificationSession	getRegistrationNotificationSession(RegistrationReceiver registrationReceiver, Proxy proxy) Gets the OsidSession associated with the registration notification service.
RegistrationNotificationSession	getRegistrationNotificationSessionForCourseCatalog(RegistrationReceiver registrationReceiver, Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the registration notification service for the given course catalog.
RegistrationQuerySession	getRegistrationQuerySession(Proxy proxy) Gets the OsidSession associated with the registration query service.
RegistrationQuerySession	getRegistrationQuerySessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the registration query service for the given course catalog.
RegistrationSearchSession	getRegistrationSearchSession(Proxy proxy) Gets the OsidSession associated with the registration search service.
RegistrationSearchSession	getRegistrationSearchSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the registration search service for the given course catalog.
RegistrationSmartCourseCatalogSession	getRegistrationSmartCourseCatalogSession(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the registration smart course catalog service.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the activity bundle lookup service.

Parameters:

proxy - proxy

Returns:

an ActivityBundleSession

Throws:

NullArgumentException - proxy is null

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,
                                                                         Proxy proxy)
                                                                           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

proxy - proxy

Returns:

an ActivityBundleLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - proxy or 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(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the activity bundle query service.

Parameters:

proxy - proxy

Returns:

an ActivityBundleQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                                       Proxy proxy)
                                                                         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

proxy - proxy

Returns:

an ActivityBundleQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or 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(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the activity bundle search service.

Parameters:

proxy - proxy

Returns:

an ActivityBundleSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                                         Proxy proxy)
                                                                           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

proxy - proxy

Returns:

an ActivityBundleSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or 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(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the activity bundle administration service.

Parameters:

proxy - proxy

Returns:

an ActivityBundleAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                       Proxy proxy)
                                                                         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

proxy - proxy

Returns:

an ActivityBundleAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or 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,
                                                                     Proxy proxy)
                                                                       throws OperationFailedException

Gets the OsidSession associated with the activity bundle notification service.

Parameters:

activityBundleReceiver - the notification callback

proxy - proxy

Returns:

an ActivityBundleNotificationSession

Throws:

NullArgumentException - activityBundleReceiver or proxy 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,
                                                                                     Proxy proxy)
                                                                                       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

proxy - proxy

Returns:

an ActivityBundleNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - activityBundleReceiver, courseCatalogId or proxy 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(Proxy proxy)
                                                                         throws OperationFailedException

Gets the OsidSession to lookup activity bundle/course catalog mappings.

Parameters:

proxy - proxy

Returns:

an ActivityBundleCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBundleCourseCatalog() is false

Compliance:

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

getActivityBundleCourseCatalogAssignmentSession

ActivityBundleCourseCatalogAssignmentSession getActivityBundleCourseCatalogAssignmentSession(Proxy proxy)
                                                                                             throws OperationFailedException

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

Parameters:

proxy - proxy

Returns:

an ActivityBundleCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                                                 Proxy proxy)
                                                                                   throws NotFoundException,
                                                                                          OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an ActivityBundleSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy 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(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the registration lookup service.

Parameters:

proxy - proxy

Returns:

a RegistrationSession

Throws:

NullArgumentException - proxy is null

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,
                                                                     Proxy proxy)
                                                                       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

proxy - proxy

Returns:

a RegistrationLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - proxy or 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the registration query service.

Parameters:

proxy - proxy

Returns:

a RegistrationQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                                   Proxy proxy)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a RegistrationQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or 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(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the registration search service.

Parameters:

proxy - proxy

Returns:

a RegistrationSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a RegistrationSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the registration administration service.

Parameters:

proxy - proxy

Returns:

a RegistrationAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                   Proxy proxy)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a RegistrationAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or 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,
                                                                 Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the registration notification service.

Parameters:

registrationReceiver - the notification callback

proxy - proxy

Returns:

a RegistrationNotificationSession

Throws:

NullArgumentException - registrationReceiver or proxy 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,
                                                                                 Proxy proxy)
                                                                                   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

proxy - proxy

Returns:

a RegistrationNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - registrationReceiver, courseCatalogId or proxy 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(Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession to lookup registration/catalog mappings.

Parameters:

proxy - proxy

Returns:

a RegistrationCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationCourseCatalog() is false

Compliance:

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

getRegistrationCourseCatalogAssignmentSession

RegistrationCourseCatalogAssignmentSession getRegistrationCourseCatalogAssignmentSession(Proxy proxy)
                                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning registrations to course catalogs.

Parameters:

proxy - proxy

Returns:

a RegistrationCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                                             Proxy proxy)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a RegistrationSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy 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(Proxy proxy)
                                                                       throws OperationFailedException

Gets the OsidSession associated with the activity registration lookup service.

Parameters:

proxy - proxy

Returns:

an ActivityRegistrationSession

Throws:

NullArgumentException - proxy is null

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,
                                                                                     Proxy proxy)
                                                                                       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

proxy - proxy

Returns:

an ActivityRegistrationLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - proxy or 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(Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession associated with the activity registration query service.

Parameters:

proxy - proxy

Returns:

an ActivityRegistrationQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                                                   Proxy proxy)
                                                                                     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

proxy - proxy

Returns:

an ActivityRegistrationQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or 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(Proxy proxy)
                                                                       throws OperationFailedException

Gets the OsidSession associated with the activity registration search service.

Parameters:

proxy - proxy

Returns:

an ActivityRegistrationSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                                                     Proxy proxy)
                                                                                       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

proxy - proxy

Returns:

an ActivityRegistrationSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or 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(Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession associated with the activity registration administration service.

Parameters:

proxy - proxy

Returns:

an ActivityRegistrationAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                                   Proxy proxy)
                                                                                     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

proxy - proxy

Returns:

an ActivityRegistrationAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or 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,
                                                                                 Proxy proxy)
                                                                                   throws OperationFailedException

Gets the OsidSession associated with the activity registration notification service.

Parameters:

activityRegistrationReceiver - the notification callback

proxy - proxy

Returns:

an ActivityRegistrationNotificationSession

Throws:

NullArgumentException - activityRegistrationReceiver or proxy 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,
                                                                                                 Proxy proxy)
                                                                                                   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

proxy - proxy

Returns:

an ActivityRegistrationNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - activityRegistrationReceiver, courseCatalogId or proxy 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(Proxy proxy)
                                                                                     throws OperationFailedException

Gets the OsidSession to lookup activity registration/course catalog mappings.

Parameters:

proxy - proxy

Returns:

an ActivityRegistrationCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityRegistrationCourseCatalog() is false

Compliance:

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

getActivityRegistrationCourseCatalogAssignmentSession

ActivityRegistrationCourseCatalogAssignmentSession getActivityRegistrationCourseCatalogAssignmentSession(Proxy proxy)
                                                                                                         throws OperationFailedException

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

Parameters:

proxy - proxy

Returns:

an ActivityRegistrationCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                                                             Proxy proxy)
                                                                                               throws NotFoundException,
                                                                                                      OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an ActivityRegistrationSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy 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

getCourseRegistrationBatchProxyManager

CourseRegistrationBatchProxyManager getCourseRegistrationBatchProxyManager()
                                                                           throws OperationFailedException

Gets a CourseRegistrationBatchProxyManager.

Returns:

a CourseRegistrationBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRegistrationBatch() is false

Compliance:

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