org.osid.course.program

Interface CourseProgramProxyManager

All Superinterfaces:

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

public interface CourseProgramProxyManager
extends OsidProxyManager, CourseProgramProfile

The course manager provides access to course management sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy for the purposes of passing information within a server application environment. The sessions included in this manager are:

• ProgramLookupSession: a session to retrieve programs
• ProgramQuerySession: a session to query programs
• ProgramSearchSession: a session to search for programs
• ProgramAdminSession: a session to create and delete programs
• ProgramNotificationSession: a session to receive notifications pertaining to program changes
• ProgramCourseCatalogSession: a session to look up program to course catalog mappings
• ProgramCourseCatalogAssignmentSession: a session to manage program to course catalog mappings
• ProgramSmartCourseCatalogSession: a session to manage dynamic course catalogs of programs
• CourseProgramLookupSession: a session to look up course to program mappings
• CourseProgramAssignmentSession: a session to manage course to program mappings

• ProgramOfferingLookupSession: a session to retrieve program offerings
• ProgramOfferingQuerySession: a session to query program offerings
• ProgramOfferingSearchSession: a session to search for program offerings
• ProgramOfferingAdminSession: a session to create and delete program offerings
• ProgramOfferingNotificationSession: a session to receive notifications pertaining to program offering changes
• ProgramOfferingCourseCatalogSession: a session to look up program offering to course catalog mappings
• ProgramOfferingCourseCatalogAssignmentSession: a session to manage program offering to course catalog mappings
• ProgramOfferingSmartCourseCatalogSession: a session to manage dynamic course catalogs of program offerings

• CredentialLookupSession: a session to retrieve credentials
• CredentialQuerySession: a session to query credentials
• CredentialSearchSession: a session to search for credentials
• CredentialAdminSession: a session to create and delete credentials
• CredentialNotificationSession: a session to receive notifications pertaining to credential changes
• CredentialCourseCatalogSession: a session to look up credential to course catalog mappings
• CredentialCourseCatalogAssignmentSession: a session to manage credential to course catalog mappings
• CredentialSmartCourseCatalogSession: a session to manage dynamic course catalogs of credentials

• EnrollmentLookupSession: a session to retrieve enrollments
• EnrollmentQuerySession: a session to query enrollments
• EnrollmentSearchSession: a session to search for enrollments
• EnrollmentAdminSession: a session to create and delete enrollments
• EnrollmentNotificationSession: a session to receive notifications pertaining to enrollment changes
• EnrollmentCourseCatalogSession: a session to look up enrollment to course catalog mappings
• EnrollmentCourseCatalogAssignmentSession: a session to manage enrollment to course catalog mappings
• EnrollmentSmartCourseCatalogSession: a session to manage dynamic course catalogs of enrollments

Method Summary

Methods

Modifier and Type	Method and Description
CourseProgramAssignmentSession	getCourseProgramAssignmentSession(Proxy proxy) Gets the OsidSession associated with managing course to program mappings.
CourseProgramAssignmentSession	getCourseProgramAssignmentSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with managing course to program mappings for the given course catalog.
CourseProgramBatchProxyManager	getCourseProgramBatchProxyManager() Gets a CourseProgramBatchProxyManager.
CourseProgramLookupSession	getCourseProgramLookupSession(Proxy proxy) Gets the OsidSession associated with looking up course to program mappings.
CourseProgramLookupSession	getCourseProgramLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with looking up course to program mappings for the given course catalog.
CredentialAdminSession	getCredentialAdminSession(Proxy proxy) Gets the OsidSession associated with the course administration service.
CredentialAdminSession	getCredentialAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the credential administration service for the given course catalog.
CredentialCourseCatalogAssignmentSession	getCredentialCourseCatalogAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning credentials to course catalogs.
CredentialCourseCatalogSession	getCredentialCourseCatalogSession(Proxy proxy) Gets the OsidSession to lookup credential/catalog mappings.
CredentialLookupSession	getCredentialLookupSession(Proxy proxy) Gets the OsidSession associated with the credential lookup service.
CredentialLookupSession	getCredentialLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the credential lookup service for the given course catalog.
CredentialNotificationSession	getCredentialNotificationSession(CredentialReceiver credentialReceiver, Proxy proxy) Gets the OsidSession associated with the credential notification service.
CredentialNotificationSession	getCredentialNotificationSessionForCourseCatalog(CredentialReceiver credentialReceiver, Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the credential notification service for the given course catalog.
CredentialQuerySession	getCredentialQuerySession(Proxy proxy) Gets the OsidSession associated with the credential query service.
CredentialQuerySession	getCredentialQuerySessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the credential query service for the given course catalog.
CredentialSearchSession	getCredentialSearchSession(Proxy proxy) Gets the OsidSession associated with the credential search service.
CredentialSearchSession	getCredentialSearchSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the credential search service for the given course catalog.
CredentialSmartCourseCatalogSession	getCredentialSmartCourseCatalogSession(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the credential smart course catalog service.
EnrollmentAdminSession	getEnrollmentAdminSession(Proxy proxy) Gets the OsidSession associated with the enrollment administration service.
EnrollmentAdminSession	getEnrollmentAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the enrollment administration service for the given course catalog.
EnrollmentCourseCatalogAssignmentSession	getEnrollmentCourseCatalogAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning enrollments to course catalogs.
EnrollmentCourseCatalogSession	getEnrollmentCourseCatalogSession(Proxy proxy) Gets the OsidSession to lookup enrollment/course catalog mappings.
EnrollmentLookupSession	getEnrollmentLookupSession(Proxy proxy) Gets the OsidSession associated with the enrollment lookup service.
EnrollmentLookupSession	getEnrollmentLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the enrollment lookup service for the given course catalog.
EnrollmentNotificationSession	getEnrollmentNotificationSession(EnrollmentReceiver enrollmentReceiver, Proxy proxy) Gets the OsidSession associated with the enrollment notification service.
EnrollmentNotificationSession	getEnrollmentNotificationSessionForCourseCatalog(EnrollmentReceiver enrollmentReceiver, Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the enrollment notification service for the given course catalog.
EnrollmentQuerySession	getEnrollmentQuerySession(Proxy proxy) Gets the OsidSession associated with the enrollment query service.
EnrollmentQuerySession	getEnrollmentQuerySessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the enrollment query service for the given course catalog.
EnrollmentSearchSession	getEnrollmentSearchSession(Proxy proxy) Gets the OsidSession associated with the enrollment search service.
EnrollmentSearchSession	getEnrollmentSearchSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the enrollment search service for the given course catalog.
EnrollmentSmartCourseCatalogSession	getEnrollmentSmartCourseCatalogSession(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the enrollment smart course catalog service.
ProgramAdminSession	getProgramAdminSession(Proxy proxy) Gets the OsidSession associated with the program administration service.
ProgramAdminSession	getProgramAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the program administration service for the given course catalog.
ProgramCourseCatalogAssignmentSession	getProgramCourseCatalogAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning programs to course catalogs.
ProgramCourseCatalogSession	getProgramCourseCatalogSession(Proxy proxy) Gets the OsidSession to lookup program/catalog mappings.
ProgramLookupSession	getProgramLookupSession(Proxy proxy) Gets the OsidSession associated with the program lookup service.
ProgramLookupSession	getProgramLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the program lookup service for the given course catalog.
ProgramNotificationSession	getProgramNotificationSession(ProgramReceiver programReceiver, Proxy proxy) Gets the OsidSession associated with the program notification service.
ProgramNotificationSession	getProgramNotificationSessionForCourseCatalog(ProgramReceiver programReceiver, Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the program notification service for the given course catalog.
ProgramOfferingAdminSession	getProgramOfferingAdminSession(Proxy proxy) Gets the OsidSession associated with the program offering administration service.
ProgramOfferingAdminSession	getProgramOfferingAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the program offering administration service for the given course catalog.
ProgramOfferingCourseCatalogAssignmentSession	getProgramOfferingCourseCatalogAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning program offerings to course catalogs.
ProgramOfferingCourseCatalogSession	getProgramOfferingCourseCatalogSession(Proxy proxy) Gets the OsidSession to lookup program offering/catalog mappings.
ProgramOfferingLookupSession	getProgramOfferingLookupSession(Proxy proxy) Gets the OsidSession associated with the program offering lookup service.
ProgramOfferingLookupSession	getProgramOfferingLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the program offering lookup service for the given course catalog.
ProgramOfferingNotificationSession	getProgramOfferingNotificationSession(ProgramOfferingReceiver programOfferingReceiver, Proxy proxy) Gets the OsidSession associated with the program offering notification service.
ProgramOfferingNotificationSession	getProgramOfferingNotificationSessionForCourseCatalog(ProgramOfferingReceiver programOfferingReceiver, Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the program offering notification service for the given course catalog.
ProgramOfferingQuerySession	getProgramOfferingQuerySession(Proxy proxy) Gets the OsidSession associated with the program offering query service.
ProgramOfferingQuerySession	getProgramOfferingQuerySessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the program offering query service for the given course catalog.
ProgramOfferingSearchSession	getProgramOfferingSearchSession(Proxy proxy) Gets the OsidSession associated with the program offering search service.
ProgramOfferingSearchSession	getProgramOfferingSearchSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the program offering search service for the given course catalog.
ProgramOfferingSmartCourseCatalogSession	getProgramOfferingSmartCourseCatalogSession(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the program offering smart course catalog service.
ProgramQuerySession	getProgramQuerySession(Proxy proxy) Gets the OsidSession associated with the program query service.
ProgramQuerySession	getProgramQuerySessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the program query service for the given course catalog.
ProgramSearchSession	getProgramSearchSession(Proxy proxy) Gets the OsidSession associated with the program search service.
ProgramSearchSession	getProgramSearchSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the program search service for the given course catalog.
ProgramSmartCourseCatalogSession	getProgramSmartCourseCatalogSession(Id courseCatalogId, Proxy proxy) Gets the OsidSession associated with the program 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.program.CourseProgramProfile

getCredentialRecordTypes, getCredentialSearchRecordTypes, getEnrollmentRecordTypes, getEnrollmentSearchRecordTypes, getProgramOfferingRecordTypes, getProgramOfferingSearchRecordTypes, getProgramRecordTypes, getProgramSearchRecordTypes, supportsCourseProgramAssignment, supportsCourseProgramBatch, supportsCourseProgramLookup, supportsCredentialAdmin, supportsCredentialCourseCatalog, supportsCredentialCourseCatalogAssignment, supportsCredentialLookup, supportsCredentialNotification, supportsCredentialQuery, supportsCredentialRecordType, supportsCredentialSearch, supportsCredentialSearchRecordType, supportsCredentialSmartCourseCatalog, supportsEnrollmentAdmin, supportsEnrollmentCourseCatalog, supportsEnrollmentCourseCatalogAssignment, supportsEnrollmentLookup, supportsEnrollmentNotification, supportsEnrollmentQuery, supportsEnrollmentRecordType, supportsEnrollmentSearch, supportsEnrollmentSearchRecordType, supportsEnrollmentSmartCourseCatalog, supportsProgramAdmin, supportsProgramCourseCatalog, supportsProgramCourseCatalogAssignment, supportsProgramLookup, supportsProgramNotification, supportsProgramOfferingAdmin, supportsProgramOfferingCourseCatalog, supportsProgramOfferingCourseCatalogAssignment, supportsProgramOfferingLookup, supportsProgramOfferingNotification, supportsProgramOfferingQuery, supportsProgramOfferingRecordType, supportsProgramOfferingSearch, supportsProgramOfferingSearchRecordType, supportsProgramOfferingSmartCourseCatalog, supportsProgramQuery, supportsProgramRecordType, supportsProgramSearch, supportsProgramSearchRecordType, supportsProgramSmartCourseCatalog, 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

getProgramLookupSession

ProgramLookupSession getProgramLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the program lookup service.

Parameters:

proxy - proxy

Returns:

a ProgramLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramLookup() is false

Compliance:

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

getProgramLookupSessionForCourseCatalog

ProgramLookupSession getProgramLookupSessionForCourseCatalog(Id courseCatalogId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

proxy - proxy

Returns:

a ProgramLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramLookup() or supportsVisibleFederation() is false

Compliance:

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

getProgramQuerySession

ProgramQuerySession getProgramQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the program query service.

Parameters:

proxy - proxy

Returns:

a ProgramQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramQuery() is false

Compliance:

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

getProgramQuerySessionForCourseCatalog

ProgramQuerySession getProgramQuerySessionForCourseCatalog(Id courseCatalogId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a ProgramQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramQuery() or supportsVisibleFederation() is false

Compliance:

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

getProgramSearchSession

ProgramSearchSession getProgramSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the program search service.

Parameters:

proxy - proxy

Returns:

a ProgramSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramSearch() is false

Compliance:

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

getProgramSearchSessionForCourseCatalog

ProgramSearchSession getProgramSearchSessionForCourseCatalog(Id courseCatalogId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a ProgramSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramSearch() or supportsVisibleFederation() is false

Compliance:

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

getProgramAdminSession

ProgramAdminSession getProgramAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the program administration service.

Parameters:

proxy - proxy

Returns:

a ProgramAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramAdmin() is false

Compliance:

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

getProgramAdminSessionForCourseCatalog

ProgramAdminSession getProgramAdminSessionForCourseCatalog(Id courseCatalogId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a ProgramAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramAdmin() or supportsVisibleFederation() is false

Compliance:

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

getProgramNotificationSession

ProgramNotificationSession getProgramNotificationSession(ProgramReceiver programReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the program notification service.

Parameters:

programReceiver - the notification callback

proxy - proxy

Returns:

a ProgramNotificationSession

Throws:

NullArgumentException - programReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramNotification() is false

Compliance:

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

getProgramNotificationSessionForCourseCatalog

ProgramNotificationSession getProgramNotificationSessionForCourseCatalog(ProgramReceiver programReceiver,
                                                                       Id courseCatalogId,
                                                                       Proxy proxy)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

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

Parameters:

programReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a ProgramNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - programReceiver, courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramNotification() or supportsVisibleFederation() is false

Compliance:

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

getProgramCourseCatalogSession

ProgramCourseCatalogSession getProgramCourseCatalogSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession to lookup program/catalog mappings.

Parameters:

proxy - proxy

Returns:

a ProgramCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramCourseCatalog() is false

Compliance:

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

getProgramCourseCatalogAssignmentSession

ProgramCourseCatalogAssignmentSession getProgramCourseCatalogAssignmentSession(Proxy proxy)
                                                                               throws OperationFailedException

Gets the OsidSession associated with assigning programs to course catalogs.

Parameters:

proxy - proxy

Returns:

a ProgramCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramCourseCatalogAssignment() is false

Compliance:

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

getProgramSmartCourseCatalogSession

ProgramSmartCourseCatalogSession getProgramSmartCourseCatalogSession(Id courseCatalogId,
                                                                   Proxy proxy)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a ProgramSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramSmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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

getCourseProgramLookupSession

CourseProgramLookupSession getCourseProgramLookupSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with looking up course to program mappings.

Parameters:

proxy - proxy

Returns:

a CourseProgramLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseProgramLookup() is false

Compliance:

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

getCourseProgramLookupSessionForCourseCatalog

CourseProgramLookupSession getCourseProgramLookupSessionForCourseCatalog(Id courseCatalogId,
                                                                       Proxy proxy)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

Gets the OsidSession associated with looking up course to program mappings for the given course catalog.

Parameters:

courseCatalogId - the Id of the course catalog

proxy - proxy

Returns:

a CourseProgramLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseProgramLookup() or supportsVisibleFederation() is false

Compliance:

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

getCourseProgramAssignmentSession

CourseProgramAssignmentSession getCourseProgramAssignmentSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with managing course to program mappings.

Parameters:

proxy - proxy

Returns:

a CourseProgramAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseProgramAssignment() is false

Compliance:

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

getCourseProgramAssignmentSessionForCourseCatalog

CourseProgramAssignmentSession getCourseProgramAssignmentSessionForCourseCatalog(Id courseCatalogId,
                                                                               Proxy proxy)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException

Gets the OsidSession associated with managing course to program mappings for the given course catalog.

Parameters:

courseCatalogId - the Id of the course catalog

proxy - proxy

Returns:

a CourseProgramAssignmentSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseProgramAssignment() or supportsVisibleFederation() is false

Compliance:

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

getProgramOfferingLookupSession

ProgramOfferingLookupSession getProgramOfferingLookupSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the program offering lookup service.

Parameters:

proxy - proxy

Returns:

a ProgramOfferingSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramOfferingLookup() is false

Compliance:

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

getProgramOfferingLookupSessionForCourseCatalog

ProgramOfferingLookupSession getProgramOfferingLookupSessionForCourseCatalog(Id courseCatalogId,
                                                                           Proxy proxy)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

proxy - proxy

Returns:

a ProgramOfferingLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramOfferingLookup() or supportsVisibleFederation() is false

Compliance:

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

getProgramOfferingQuerySession

ProgramOfferingQuerySession getProgramOfferingQuerySession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the program offering query service.

Parameters:

proxy - proxy

Returns:

a ProgramOfferingQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramOfferingQuery() is false

Compliance:

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

getProgramOfferingQuerySessionForCourseCatalog

ProgramOfferingQuerySession getProgramOfferingQuerySessionForCourseCatalog(Id courseCatalogId,
                                                                         Proxy proxy)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a ProgramOfferingQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramOfferingQuery() or supportsVisibleFederation() is false

Compliance:

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

getProgramOfferingSearchSession

ProgramOfferingSearchSession getProgramOfferingSearchSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the program offering search service.

Parameters:

proxy - proxy

Returns:

a ProgramOfferingSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramOfferingSearch() is false

Compliance:

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

getProgramOfferingSearchSessionForCourseCatalog

ProgramOfferingSearchSession getProgramOfferingSearchSessionForCourseCatalog(Id courseCatalogId,
                                                                           Proxy proxy)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a ProgramOfferingSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramOfferingSearch() or supportsVisibleFederation() is false

Compliance:

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

getProgramOfferingAdminSession

ProgramOfferingAdminSession getProgramOfferingAdminSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the program offering administration service.

Parameters:

proxy - proxy

Returns:

a ProgramOfferingAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramOfferingAdmin() is false

Compliance:

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

getProgramOfferingAdminSessionForCourseCatalog

ProgramOfferingAdminSession getProgramOfferingAdminSessionForCourseCatalog(Id courseCatalogId,
                                                                         Proxy proxy)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a ProgramOfferingAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramOfferingAdmin() or supportsVisibleFederation() is false

Compliance:

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

getProgramOfferingNotificationSession

ProgramOfferingNotificationSession getProgramOfferingNotificationSession(ProgramOfferingReceiver programOfferingReceiver,
                                                                       Proxy proxy)
                                                                         throws OperationFailedException

Gets the OsidSession associated with the program offering notification service.

Parameters:

programOfferingReceiver - the notification callback

proxy - proxy

Returns:

a ProgramOfferingNotificationSession

Throws:

NullArgumentException - programOfferingReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramOfferingNotification() is false

Compliance:

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

getProgramOfferingNotificationSessionForCourseCatalog

ProgramOfferingNotificationSession getProgramOfferingNotificationSessionForCourseCatalog(ProgramOfferingReceiver programOfferingReceiver,
                                                                                       Id courseCatalogId,
                                                                                       Proxy proxy)
                                                                                         throws NotFoundException,
                                                                                                OperationFailedException

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

Parameters:

programOfferingReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a ProgramOfferingNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - programOfferingReceiver, courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramOfferingNotification() or supportsVisibleFederation() is false

Compliance:

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

getProgramOfferingCourseCatalogSession

ProgramOfferingCourseCatalogSession getProgramOfferingCourseCatalogSession(Proxy proxy)
                                                                           throws OperationFailedException

Gets the OsidSession to lookup program offering/catalog mappings.

Parameters:

proxy - proxy

Returns:

a ProgramOfferingCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramOfferingCourseCatalog() is false

Compliance:

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

getProgramOfferingCourseCatalogAssignmentSession

ProgramOfferingCourseCatalogAssignmentSession getProgramOfferingCourseCatalogAssignmentSession(Proxy proxy)
                                                                                               throws OperationFailedException

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

Parameters:

proxy - proxy

Returns:

a ProgramOfferingCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramOfferingCourseCatalogAssignment() is false

Compliance:

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

getProgramOfferingSmartCourseCatalogSession

ProgramOfferingSmartCourseCatalogSession getProgramOfferingSmartCourseCatalogSession(Id courseCatalogId,
                                                                                   Proxy proxy)
                                                                                     throws NotFoundException,
                                                                                            OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a ProgramOfferingSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramOfferingSmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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

getCredentialLookupSession

CredentialLookupSession getCredentialLookupSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the credential lookup service.

Parameters:

proxy - proxy

Returns:

a CredentialLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialLookup() is false

Compliance:

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

getCredentialLookupSessionForCourseCatalog

CredentialLookupSession getCredentialLookupSessionForCourseCatalog(Id courseCatalogId,
                                                                 Proxy proxy)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

proxy - proxy

Returns:

a CredentialLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialLookup() or supportsVisibleFederation() is false

Compliance:

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

getCredentialQuerySession

CredentialQuerySession getCredentialQuerySession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the credential query service.

Parameters:

proxy - proxy

Returns:

a CredentialQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialQuery() is false

Compliance:

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

getCredentialQuerySessionForCourseCatalog

CredentialQuerySession getCredentialQuerySessionForCourseCatalog(Id courseCatalogId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CredentialQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialQuery() or supportsVisibleFederation() is false

Compliance:

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

getCredentialSearchSession

CredentialSearchSession getCredentialSearchSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the credential search service.

Parameters:

proxy - proxy

Returns:

a CredentialSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialSearch() is false

Compliance:

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

getCredentialSearchSessionForCourseCatalog

CredentialSearchSession getCredentialSearchSessionForCourseCatalog(Id courseCatalogId,
                                                                 Proxy proxy)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CredentialSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialSearch() or supportsVisibleFederation() is false

Compliance:

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

getCredentialAdminSession

CredentialAdminSession getCredentialAdminSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the course administration service.

Parameters:

proxy - proxy

Returns:

a CourseAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseAdmin() is false

Compliance:

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

getCredentialAdminSessionForCourseCatalog

CredentialAdminSession getCredentialAdminSessionForCourseCatalog(Id courseCatalogId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CredentialAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCredentialNotificationSession

CredentialNotificationSession getCredentialNotificationSession(CredentialReceiver credentialReceiver,
                                                             Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the credential notification service.

Parameters:

credentialReceiver - the notification callback

proxy - proxy

Returns:

a CourseNotificationSession

Throws:

NullArgumentException - credentialReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialNotification() is false

Compliance:

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

getCredentialNotificationSessionForCourseCatalog

CredentialNotificationSession getCredentialNotificationSessionForCourseCatalog(CredentialReceiver credentialReceiver,
                                                                             Id courseCatalogId,
                                                                             Proxy proxy)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

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

Parameters:

credentialReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CredentialNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - credentialReceiver, courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialNotification() or supportsVisibleFederation() is false

Compliance:

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

getCredentialCourseCatalogSession

CredentialCourseCatalogSession getCredentialCourseCatalogSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession to lookup credential/catalog mappings.

Parameters:

proxy - proxy

Returns:

a CredentialCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialCourseCatalog() is false

Compliance:

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

getCredentialCourseCatalogAssignmentSession

CredentialCourseCatalogAssignmentSession getCredentialCourseCatalogAssignmentSession(Proxy proxy)
                                                                                     throws OperationFailedException

Gets the OsidSession associated with assigning credentials to course catalogs.

Parameters:

proxy - proxy

Returns:

a CredentialCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialCourseCatalogAssignment() is false

Compliance:

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

getCredentialSmartCourseCatalogSession

CredentialSmartCourseCatalogSession getCredentialSmartCourseCatalogSession(Id courseCatalogId,
                                                                         Proxy proxy)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CredentialSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialSmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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

getEnrollmentLookupSession

EnrollmentLookupSession getEnrollmentLookupSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the enrollment lookup service.

Parameters:

proxy - proxy

Returns:

an EnrollmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEnrollmentLookup() is false

Compliance:

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

getEnrollmentLookupSessionForCourseCatalog

EnrollmentLookupSession getEnrollmentLookupSessionForCourseCatalog(Id courseCatalogId,
                                                                 Proxy proxy)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

proxy - proxy

Returns:

an EnrollmentLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEnrollmentLookup() or supportsVisibleFederation() is false

Compliance:

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

getEnrollmentQuerySession

EnrollmentQuerySession getEnrollmentQuerySession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the enrollment query service.

Parameters:

proxy - proxy

Returns:

an EnrollmentQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEnrollmentQuery() is false

Compliance:

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

getEnrollmentQuerySessionForCourseCatalog

EnrollmentQuerySession getEnrollmentQuerySessionForCourseCatalog(Id courseCatalogId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an EnrollmentQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEnrollmentQuery() or supportsVisibleFederation() is false

Compliance:

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

getEnrollmentSearchSession

EnrollmentSearchSession getEnrollmentSearchSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the enrollment search service.

Parameters:

proxy - proxy

Returns:

an EnrollmentSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEnrollmentSearch() is false

Compliance:

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

getEnrollmentSearchSessionForCourseCatalog

EnrollmentSearchSession getEnrollmentSearchSessionForCourseCatalog(Id courseCatalogId,
                                                                 Proxy proxy)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an EnrollmentSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEnrollmentSearch() or supportsVisibleFederation() is false

Compliance:

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

getEnrollmentAdminSession

EnrollmentAdminSession getEnrollmentAdminSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the enrollment administration service.

Parameters:

proxy - proxy

Returns:

an EnrollmentAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEnrollmentAdmin() is false

Compliance:

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

getEnrollmentAdminSessionForCourseCatalog

EnrollmentAdminSession getEnrollmentAdminSessionForCourseCatalog(Id courseCatalogId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an EnrollmentAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEnrollmentAdmin() or supportsVisibleFederation() is false

Compliance:

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

getEnrollmentNotificationSession

EnrollmentNotificationSession getEnrollmentNotificationSession(EnrollmentReceiver enrollmentReceiver,
                                                             Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the enrollment notification service.

Parameters:

enrollmentReceiver - the notification callback

proxy - proxy

Returns:

an EnrollmentNotificationSession

Throws:

NullArgumentException - enrollmentReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEnrollmentNotification() is false

Compliance:

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

getEnrollmentNotificationSessionForCourseCatalog

EnrollmentNotificationSession getEnrollmentNotificationSessionForCourseCatalog(EnrollmentReceiver enrollmentReceiver,
                                                                             Id courseCatalogId,
                                                                             Proxy proxy)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

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

Parameters:

enrollmentReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an EnrollmentNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - enrollmentReceiver, courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEnrollmentNotification() or supportsVisibleFederation() is false

Compliance:

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

getEnrollmentCourseCatalogSession

EnrollmentCourseCatalogSession getEnrollmentCourseCatalogSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession to lookup enrollment/course catalog mappings.

Parameters:

proxy - proxy

Returns:

an EnrollmentCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEnrollmentCourseCatalog() is false

Compliance:

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

getEnrollmentCourseCatalogAssignmentSession

EnrollmentCourseCatalogAssignmentSession getEnrollmentCourseCatalogAssignmentSession(Proxy proxy)
                                                                                     throws OperationFailedException

Gets the OsidSession associated with assigning enrollments to course catalogs.

Parameters:

proxy - proxy

Returns:

an EnrollmentCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEnrollmentCourseCatalogAssignment() is false

Compliance:

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

getEnrollmentSmartCourseCatalogSession

EnrollmentSmartCourseCatalogSession getEnrollmentSmartCourseCatalogSession(Id courseCatalogId,
                                                                         Proxy proxy)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an EnrollmentSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEnrollmentSmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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

getCourseProgramBatchProxyManager

CourseProgramBatchProxyManager getCourseProgramBatchProxyManager()
                                                                 throws OperationFailedException

Gets a CourseProgramBatchProxyManager.

Returns:

a CourseProgramBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseProgramBatch() is false

Compliance:

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