Interface CourseRegistrationProxyManager

All Superinterfaces:

AutoCloseable, Closeable, CourseRegistrationProfile, OsidProfile, OsidProxyManager, 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:

• RegistrationTargetLookupSes sion: a session to retrieve registration targets
• RegistrationTargetQuerySes sion: a session to query for registration targets
• RegistrationTargetSearchSes sion: a session to search for registration targets
• RegistrationTargetAdminSes sion: a session to create and delete registration targets
• RegistrationTargetNotificationSes sion: a session to receive notifications pertaining to registration target changes
• RegistrationTargetCourseCatalogSes sion: a session to look up registration target course catalog mappings
• RegistrationTargetCourseCatalogAssignmentSes sion: a session to manage registration target to course catalog mappings
• RegistrationTargetSmartCourseCatalogSession : a session to manage dynamic course catalogs of registration targets

• 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

• CourseRegistrationLookupSes sion: a session to retrieve course registrations
• CourseRegistrationQuerySes sion: a session to query for course registrations
• CourseRegistrationSearchSes sion: a session to search for course registrations
• CourseRegistrationAdminSes sion: a session to create and delete course registrations
• CourseRegistrationNotificationSes sion: a session to receive notifications pertaining to course registration changes
• CourseRegistrationCourseCatalogSes sion: a session to look up course registration course catalog mappings
• CourseRegistrationCourseCatalogAssignmentSes sion: a session to manage course registration to course catalog mappings
• CourseRegistrationSmartCourseCatalogSession : a session to manage dynamic course catalogs of course 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

Modifier and Type	Method	Description
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.
CourseRegistrationAdminSession	getCourseRegistrationAdminSession(Proxy proxy)	Gets the OsidSession associated with the course registration administration service.
CourseRegistrationAdminSession	getCourseRegistrationAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the course registration administration service for the given course catalog.
CourseRegistrationBatchProxyManager	getCourseRegistrationBatchProxyManager()	Gets a CourseRegistrationBatchProxyManager .
CourseRegistrationCourseCatalogAssignmentSession	getCourseRegistrationCourseCatalogAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning course registrations to course catalogs.
CourseRegistrationCourseCatalogSession	getCourseRegistrationCourseCatalogSession(Proxy proxy)	Gets the OsidSession to lookup course registration/course catalog mappings.
CourseRegistrationLookupSession	getCourseRegistrationLookupSession(Proxy proxy)	Gets the OsidSession associated with the course registration lookup service.
CourseRegistrationLookupSession	getCourseRegistrationLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the course registration lookup service for the given course catalog.
CourseRegistrationNotificationSession	getCourseRegistrationNotificationSession(CourseRegistrationReceiver courseRegistrationReceiver, Proxy proxy)	Gets the OsidSession associated with the course registration notification service.
CourseRegistrationNotificationSession	getCourseRegistrationNotificationSessionForCourseCatalog(CourseRegistrationReceiver courseRegistrationReceiver, Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the course registration notification service for the given course catalog.
CourseRegistrationQuerySession	getCourseRegistrationQuerySession(Proxy proxy)	Gets the OsidSession associated with the course registration query service.
CourseRegistrationQuerySession	getCourseRegistrationQuerySessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the course registration query service for the given course catalog.
CourseRegistrationSearchSession	getCourseRegistrationSearchSession(Proxy proxy)	Gets the OsidSession associated with the course registration search service.
CourseRegistrationSearchSession	getCourseRegistrationSearchSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the course registration search service for the given course catalog.
CourseRegistrationSmartCourseCatalogSession	getCourseRegistrationSmartCourseCatalogSession(Id courseCatalogId, Proxy proxy)	Gets the OsidSession to manage course registration smart course catalogs.
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.
RegistrationRequestProxyManager	getRegistrationRequestProxyManager()	Gets a RegistrationRequestProxyManager .
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.
RegistrationTargetAdminSession	getRegistrationTargetAdminSession(Proxy proxy)	Gets the OsidSession associated with the registration target administration service.
RegistrationTargetAdminSession	getRegistrationTargetAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the registration target administration service for the given course catalog.
RegistrationTargetCourseCatalogAssignmentSession	getRegistrationTargetCourseCatalogAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning registration targets to course catalogs.
RegistrationTargetCourseCatalogSession	getRegistrationTargetCourseCatalogSession(Proxy proxy)	Gets the OsidSession to lookup registration target/course catalog mappings.
RegistrationTargetLookupSession	getRegistrationTargetLookupSession(Proxy proxy)	Gets the OsidSession associated with the registration target lookup service.
RegistrationTargetLookupSession	getRegistrationTargetLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the registration target lookup service for the given course catalog.
RegistrationTargetNotificationSession	getRegistrationTargetNotificationSession(RegistrationTargetReceiver registrationTargetReceiver, Proxy proxy)	Gets the OsidSession associated with the registration target notification service.
RegistrationTargetNotificationSession	getRegistrationTargetNotificationSessionForCourseCatalog(RegistrationTargetReceiver registrationTargetReceiver, Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the registration target notification service for the given course catalog.
RegistrationTargetQuerySession	getRegistrationTargetQuerySession(Proxy proxy)	Gets the OsidSession associated with the registration target query service.
RegistrationTargetQuerySession	getRegistrationTargetQuerySessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the registration target query service for the given course catalog.
RegistrationTargetSearchSession	getRegistrationTargetSearchSession(Proxy proxy)	Gets the OsidSession associated with the registration target search service.
RegistrationTargetSearchSession	getRegistrationTargetSearchSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the registration target search service for the given course catalog.
RegistrationTargetSmartCourseCatalogSession	getRegistrationTargetSmartCourseCatalogSession(Id courseCatalogId, Proxy proxy)	Gets the OsidSession to manage registration target smart course catalogs.

Methods inherited from interface Closeable

close

Methods inherited from interface CourseRegistrationProfile

getActivityRegistrationRecordTypes, getActivityRegistrationSearchRecordTypes, getCourseRegistrationRecordTypes, getCourseRegistrationSearchRecordTypes, getRegistrationRecordTypes, getRegistrationSearchRecordTypes, getRegistrationTargetRecordTypes, getRegistrationTargetSearchRecordTypes, supportsActivityRegistrationAdmin, supportsActivityRegistrationCourseCatalog, supportsActivityRegistrationCourseCatalogAssignment, supportsActivityRegistrationLookup, supportsActivityRegistrationNotification, supportsActivityRegistrationQuery, supportsActivityRegistrationRecordType, supportsActivityRegistrationSearch, supportsActivityRegistrationSearchRecordType, supportsActivityRegistrationSmartCourseCatalog, supportsCourseRegistrationAdmin, supportsCourseRegistrationBatch, supportsCourseRegistrationCourseCatalog, supportsCourseRegistrationCourseCatalogAssignment, supportsCourseRegistrationLookup, supportsCourseRegistrationNotification, supportsCourseRegistrationQuery, supportsCourseRegistrationRecordType, supportsCourseRegistrationSearch, supportsCourseRegistrationSearchRecordType, supportsCourseRegistrationSmartCourseCatalog, supportsRegistrationAdmin, supportsRegistrationCourseCatalog, supportsRegistrationCourseCatalogAssignment, supportsRegistrationLookup, supportsRegistrationNotification, supportsRegistrationQuery, supportsRegistrationRecordType, supportsRegistrationRequest, supportsRegistrationSearch, supportsRegistrationSearchRecordType, supportsRegistrationSmartCourseCatalog, supportsRegistrationTargetAdmin, supportsRegistrationTargetCourseCatalog, supportsRegistrationTargetCourseCatalogAssignment, supportsRegistrationTargetLookup, supportsRegistrationTargetNotification, supportsRegistrationTargetQuery, supportsRegistrationTargetRecordType, supportsRegistrationTargetSearch, supportsRegistrationTargetSearchRecordType, supportsRegistrationTargetSmartCourseCatalog, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getActivityRegistrationRecordTypes()	Gets the supported ActivityRegistration record types.
TypeList	getActivityRegistrationSearchRecordTypes()	Gets the supported ActivityRegistration search record types.
TypeList	getCourseRegistrationRecordTypes()	Gets the supported CourseRegistration record types.
TypeList	getCourseRegistrationSearchRecordTypes()	Gets the supported CourseRegistration search types.
TypeList	getRegistrationRecordTypes()	Gets the supported Registration record types.
TypeList	getRegistrationSearchRecordTypes()	Gets the supported Registration search record types.
TypeList	getRegistrationTargetRecordTypes()	Gets the supported RegistrationTarget record types.
TypeList	getRegistrationTargetSearchRecordTypes()	Gets the supported RegistrationTarget search types.
boolean	supportsActivityRegistrationAdmin()	Tests if an activity registration administrative service is supported.
boolean	supportsActivityRegistrationCourseCatalog()	Tests if an activity registration cataloging service is supported.
boolean	supportsActivityRegistrationCourseCatalogAssignment()	Tests if an activity registration cataloging service is supported.
boolean	supportsActivityRegistrationLookup()	Tests if looking up activity registrations is supported.
boolean	supportsActivityRegistrationNotification()	Tests if an activity registration notification service is supported.
boolean	supportsActivityRegistrationQuery()	Tests if querying activity registrations is supported.
boolean	supportsActivityRegistrationRecordType(Type activityRegistrationRecordType)	Tests if the given ActivityRegistration record type is supported.
boolean	supportsActivityRegistrationSearch()	Tests if searching activity registrations is supported.
boolean	supportsActivityRegistrationSearchRecordType(Type activityRegistrationSearchRecordType)	Tests if the given ActivityRegistration search record type is supported.
boolean	supportsActivityRegistrationSmartCourseCatalog()	Tests if an activity registration smart course catalog session is available.
boolean	supportsCourseRegistrationAdmin()	Tests if a course registration administrative service is supported.
boolean	supportsCourseRegistrationBatch()	Tests if a course registration batch service is available.
boolean	supportsCourseRegistrationCourseCatalog()	Tests if a course registration course catalog lookup service is supported.
boolean	supportsCourseRegistrationCourseCatalogAssignment()	Tests if a course registration course catalog assignment service is supported.
boolean	supportsCourseRegistrationLookup()	Tests if looking up course registrations is supported.
boolean	supportsCourseRegistrationNotification()	Tests if a course registration notification service is supported.
boolean	supportsCourseRegistrationQuery()	Tests if querying course registrations is supported.
boolean	supportsCourseRegistrationRecordType(Type courseRegistrationRecordType)	Tests if the given CourseRegistration record type is supported.
boolean	supportsCourseRegistrationSearch()	Tests if searching course registrations is supported.
boolean	supportsCourseRegistrationSearchRecordType(Type courseRegistrationSearchRecordType)	Tests if the given CourseRegistration search type is supported.
boolean	supportsCourseRegistrationSmartCourseCatalog()	Tests if a course registration smart course catalog service is supported.
boolean	supportsRegistrationAdmin()	Tests if course offering administrative service is supported.
boolean	supportsRegistrationCourseCatalog()	Tests if a registration cataloging service is supported.
boolean	supportsRegistrationCourseCatalogAssignment()	Tests if a registration cataloging service is supported.
boolean	supportsRegistrationLookup()	Tests if looking up registrations is supported.
boolean	supportsRegistrationNotification()	Tests if a registration notification service is supported.
boolean	supportsRegistrationQuery()	Tests if querying registrations is supported.
boolean	supportsRegistrationRecordType(Type registrationRecordType)	Tests if the given Registration record type is supported.
boolean	supportsRegistrationRequest()	Tests if a course registration request service is available.
boolean	supportsRegistrationSearch()	Tests if searching registrations is supported.
boolean	supportsRegistrationSearchRecordType(Type registrationSearchRecordType)	Tests if the given Registration search record type is supported.
boolean	supportsRegistrationSmartCourseCatalog()	Tests if a registration smart course catalog session is available.
boolean	supportsRegistrationTargetAdmin()	Tests if a registration target administrative service is supported.
boolean	supportsRegistrationTargetCourseCatalog()	Tests if a registration target course catalog lookup service is supported.
boolean	supportsRegistrationTargetCourseCatalogAssignment()	Tests if a registration target course catalog assignment service is supported.
boolean	supportsRegistrationTargetLookup()	Tests if looking up registration targets is supported.
boolean	supportsRegistrationTargetNotification()	Tests if a registration target notification service is supported.
boolean	supportsRegistrationTargetQuery()	Tests if querying registration targets is supported.
boolean	supportsRegistrationTargetRecordType(Type registrationTargetRecordType)	Tests if the given RegistrationTarget record type is supported.
boolean	supportsRegistrationTargetSearch()	Tests if searching registration targets is supported.
boolean	supportsRegistrationTargetSearchRecordType(Type registrationTargetSearchRecordType)	Tests if the given RegistrationTarget search type is supported.
boolean	supportsRegistrationTargetSmartCourseCatalog()	Tests if a registration target smart course catalog service is supported.
boolean	supportsVisibleFederation()	Tests if any course catalog federation is exposed.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

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

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

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

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getRegistrationTargetLookupSession

RegistrationTargetLookupSession getRegistrationTargetLookupSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the registration target lookup service.

Parameters:

proxy - a proxy

Returns:

a RegistrationTargetLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationTargetLookup() is false

Compliance:

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

getRegistrationTargetLookupSessionForCourseCatalog

RegistrationTargetLookupSession getRegistrationTargetLookupSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a RegistrationTargetLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationTargetLookup() or supportsVisibleFederation() is false

Compliance:

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

getRegistrationTargetQuerySession

RegistrationTargetQuerySession getRegistrationTargetQuerySession(Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the registration target query service.

Parameters:

proxy - a proxy

Returns:

a RegistrationTargetQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationTargetQuery() is false

Compliance:

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

getRegistrationTargetQuerySessionForCourseCatalog

RegistrationTargetQuerySession getRegistrationTargetQuerySessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a RegistrationTargetQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationTargetQuery() or supportsVisibleFederation() is false

Compliance:

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

getRegistrationTargetSearchSession

RegistrationTargetSearchSession getRegistrationTargetSearchSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the registration target search service.

Parameters:

proxy - a proxy

Returns:

a RegistrationTargetSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationTargetSearch() is false

Compliance:

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

getRegistrationTargetSearchSessionForCourseCatalog

RegistrationTargetSearchSession getRegistrationTargetSearchSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a RegistrationTargetSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationTargetSearch() or supportsVisibleFederation() is false

Compliance:

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

getRegistrationTargetAdminSession

RegistrationTargetAdminSession getRegistrationTargetAdminSession(Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the registration target administration service.

Parameters:

proxy - a proxy

Returns:

a RegistrationTargetAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationTargetAdmin() is false

Compliance:

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

getRegistrationTargetAdminSessionForCourseCatalog

RegistrationTargetAdminSession getRegistrationTargetAdminSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a RegistrationTargetAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationTargetAdmin() or supportsVisibleFederation() is false

Compliance:

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

getRegistrationTargetNotificationSession

RegistrationTargetNotificationSession getRegistrationTargetNotificationSession(RegistrationTargetReceiver registrationTargetReceiver,
 Proxy proxy)
                                                                        throws OperationFailedException

Gets the OsidSession associated with the registration target notification service.

Parameters:

registrationTargetReceiver - the notification callback

proxy - a proxy

Returns:

a RegistrationTargetNotificationSession

Throws:

NullArgumentException - registrationTargetReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationTargetNotification() is false

Compliance:

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

getRegistrationTargetNotificationSessionForCourseCatalog

RegistrationTargetNotificationSession getRegistrationTargetNotificationSessionForCourseCatalog(RegistrationTargetReceiver registrationTargetReceiver,
 Id courseCatalogId,
 Proxy proxy)
                                                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

registrationTargetReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a RegistrationTargetNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - registrationTargetReceiver , courseCatalogId , or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationTargetNotification() or supportsVisibleFederation() is false

Compliance:

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

getRegistrationTargetCourseCatalogSession

RegistrationTargetCourseCatalogSession getRegistrationTargetCourseCatalogSession(Proxy proxy)
                                                                          throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a RegistrationTargetCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationTargetCourseCatalog() is false

Compliance:

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

getRegistrationTargetCourseCatalogAssignmentSession

RegistrationTargetCourseCatalogAssignmentSession getRegistrationTargetCourseCatalogAssignmentSession(Proxy proxy)
                                                                                              throws OperationFailedException

Gets the OsidSession associated with assigning registration targets to course catalogs.

Parameters:

proxy - a proxy

Returns:

a RegistrationTargetCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationTargetCourseCatalogAssignment() is false

Compliance:

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

getRegistrationTargetSmartCourseCatalogSession

RegistrationTargetSmartCourseCatalogSession getRegistrationTargetSmartCourseCatalogSession(Id courseCatalogId,
 Proxy proxy)
                                                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage registration target smart course catalogs.

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - a proxy

Returns:

a RegistrationTargetSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationTargetSmartCourseCatalog() is false

Compliance:

optional - This method must be implemented if {@code supportsRegistrationTargetSmartCourseCatalog()} is {@code 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 {@code supportsRegistrationLookup()} is {@code 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 {@code supportsRegistrationLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRegistrationQuery()} is {@code 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 {@code supportsRegistrationQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRegistrationSearch()} is {@code 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 {@code supportsRegistrationSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRegistrationAdmin()} is {@code 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 {@code supportsRegistrationAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRegistrationNotification()} is {@code 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 {@code supportsRegistrationNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRegistrationCourseCatalog()} is {@code 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 {@code supportsRegistrationCourseCatalogAssignment()} is {@code 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 {@code supportsRegistrationSmartCourseCatalog()} and {@code supportsVisibleFederation()} are {@code true} .

getCourseRegistrationLookupSession

CourseRegistrationLookupSession getCourseRegistrationLookupSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the course registration lookup service.

Parameters:

proxy - proxy

Returns:

a CourseRegistrationLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRegistrationLookup() is false

Compliance:

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

getCourseRegistrationLookupSessionForCourseCatalog

CourseRegistrationLookupSession getCourseRegistrationLookupSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CourseRegistrationLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRegistrationLookup() or supportsVisibleFederation() is false

Compliance:

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

getCourseRegistrationQuerySession

CourseRegistrationQuerySession getCourseRegistrationQuerySession(Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the course registration query service.

Parameters:

proxy - proxy

Returns:

a CourseRegistrationQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRegistrationQuery() is false

Compliance:

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

getCourseRegistrationQuerySessionForCourseCatalog

CourseRegistrationQuerySession getCourseRegistrationQuerySessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CourseRegistrationQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRegistrationQuery() or supportsVisibleFederation() is false

Compliance:

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

getCourseRegistrationSearchSession

CourseRegistrationSearchSession getCourseRegistrationSearchSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the course registration search service.

Parameters:

proxy - proxy

Returns:

a CourseRegistrationSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRegistrationSearch() is false

Compliance:

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

getCourseRegistrationSearchSessionForCourseCatalog

CourseRegistrationSearchSession getCourseRegistrationSearchSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CourseRegistrationSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRegistrationSearch() or supportsVisibleFederation() is false

Compliance:

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

getCourseRegistrationAdminSession

CourseRegistrationAdminSession getCourseRegistrationAdminSession(Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the course registration administration service.

Parameters:

proxy - proxy

Returns:

a CourseRegistrationAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRegistrationAdmin() is false

Compliance:

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

getCourseRegistrationAdminSessionForCourseCatalog

CourseRegistrationAdminSession getCourseRegistrationAdminSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CourseRegistrationAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRegistrationAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCourseRegistrationNotificationSession

CourseRegistrationNotificationSession getCourseRegistrationNotificationSession(CourseRegistrationReceiver courseRegistrationReceiver,
 Proxy proxy)
                                                                        throws OperationFailedException

Gets the OsidSession associated with the course registration notification service.

Parameters:

courseRegistrationReceiver - the notification callback

proxy - proxy

Returns:

a CourseRegistrationNotificationSession

Throws:

NullArgumentException - courseRegistrationReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRegistrationNotification() is false

Compliance:

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

getCourseRegistrationNotificationSessionForCourseCatalog

CourseRegistrationNotificationSession getCourseRegistrationNotificationSessionForCourseCatalog(CourseRegistrationReceiver courseRegistrationReceiver,
 Id courseCatalogId,
 Proxy proxy)
                                                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

courseRegistrationReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CourseRegistrationNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseRegistrationReceiver, courseCatalogId , or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRegistrationNotification() or supportsVisibleFederation() is false

Compliance:

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

getCourseRegistrationCourseCatalogSession

CourseRegistrationCourseCatalogSession getCourseRegistrationCourseCatalogSession(Proxy proxy)
                                                                          throws OperationFailedException

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

Parameters:

proxy - proxy

Returns:

a CourseRegistrationCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRegistrationCourseCatalog() is false

Compliance:

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

getCourseRegistrationCourseCatalogAssignmentSession

CourseRegistrationCourseCatalogAssignmentSession getCourseRegistrationCourseCatalogAssignmentSession(Proxy proxy)
                                                                                              throws OperationFailedException

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

Parameters:

proxy - proxy

Returns:

a CourseRegistrationCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRegistrationCourseCatalogAssignment() is false

Compliance:

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

getCourseRegistrationSmartCourseCatalogSession

CourseRegistrationSmartCourseCatalogSession getCourseRegistrationSmartCourseCatalogSession(Id courseCatalogId,
 Proxy proxy)
                                                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage course registration smart course catalogs.

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CourseRegistrationSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseRegistrationSmartCourseCatalog() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseRegistrationSmartCourseCatalog()} is {@code 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 {@code supportsActivityRegistrationLookup()} is {@code 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 {@code supportsActivityRegistrationLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsActivityRegistrationQuery()} is {@code 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 {@code supportsActivityRegistrationQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsActivityRegistrationSearch()} is {@code 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 {@code supportsActivityRegistrationSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsActivityRegistrationAdmin()} is {@code 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 {@code supportsActivityRegistrationAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsActivityRegistrationNotification()} is {@code 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 {@code supportsActivityRegistrationNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsActivityRegistrationCourseCatalog()} is {@code 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 {@code supportsActivityRegistrationCourseCatalogAssignment()} is {@code 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 {@code supportsActivityRegistrationSmartCourseCatalog()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsACourseRegistrationBatch()} is {@code true} .

getRegistrationRequestProxyManager

RegistrationRequestProxyManager getRegistrationRequestProxyManager()
                                                            throws OperationFailedException

Gets a RegistrationRequestProxyManager .

Returns:

a RegistrationRequestProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRegistrationRequest() is false

Compliance:

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