Interface CourseProgramProxyManager

All Superinterfaces:

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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getCredentialRecordTypes()	Gets the supported credential record types.
TypeList	getCredentialSearchRecordTypes()	Gets the supported credential search record types.
TypeList	getEnrollmentRecordTypes()	Gets the supported Enrollment record types.
TypeList	getEnrollmentSearchRecordTypes()	Gets the supported Enrollment search record types.
TypeList	getProgramOfferingRecordTypes()	Gets the supported ProgramOffering record types.
TypeList	getProgramOfferingSearchRecordTypes()	Gets the supported ProgramOffering search record types.
TypeList	getProgramRecordTypes()	Gets the supported program record types.
TypeList	getProgramSearchRecordTypes()	Gets the supported program search record types.
boolean	supportsCourseProgramAssignment()	Tests if a course/program mapping service is supported.
boolean	supportsCourseProgramBatch()	Tests if a course program batch service is available.
boolean	supportsCourseProgramLookup()	Tests if a course/program lookup service is supported.
boolean	supportsCredentialAdmin()	Tests if course administrative service is supported.
boolean	supportsCredentialCourseCatalog()	Tests if a course cataloging service is supported.
boolean	supportsCredentialCourseCatalogAssignment()	Tests if a course cataloging service is supported.
boolean	supportsCredentialLookup()	Tests if looking up courses is supported.
boolean	supportsCredentialNotification()	Tests if a course notification service is supported.
boolean	supportsCredentialQuery()	Tests if querying courses is supported.
boolean	supportsCredentialRecordType(Type credentialRecordType)	Tests if the given credential record type is supported.
boolean	supportsCredentialSearch()	Tests if searching courses is supported.
boolean	supportsCredentialSearchRecordType(Type credentialSearchRecordType)	Tests if the given credential search record type is supported.
boolean	supportsCredentialSmartCourseCatalog()	Tests if a credential smart course catalog session is available.
boolean	supportsEnrollmentAdmin()	Tests if an enrollment administrative service is supported.
boolean	supportsEnrollmentCourseCatalog()	Tests if an enrollment cataloging service is supported.
boolean	supportsEnrollmentCourseCatalogAssignment()	Tests if an enrollment cataloging service is supported.
boolean	supportsEnrollmentLookup()	Tests if looking up enrollments is supported.
boolean	supportsEnrollmentNotification()	Tests if an enrollment notification service is supported.
boolean	supportsEnrollmentQuery()	Tests if querying enrollments is supported.
boolean	supportsEnrollmentRecordType(Type enrollmentRecordType)	Tests if the given Enrollment record type is supported.
boolean	supportsEnrollmentSearch()	Tests if searching enrollments is supported.
boolean	supportsEnrollmentSearchRecordType(Type enrollmentSearchRecordType)	Tests if the given Enrollment search record type is supported.
boolean	supportsEnrollmentSmartCourseCatalog()	Tests if an enrollment smart course catalog session is available.
boolean	supportsProgramAdmin()	Tests if program administrative service is supported.
boolean	supportsProgramCourseCatalog()	Tests if a program cataloging service is supported.
boolean	supportsProgramCourseCatalogAssignment()	Tests if a course cataloging service is supported.
boolean	supportsProgramLookup()	Tests if looking up programs is supported.
boolean	supportsProgramNotification()	Tests if a program notification service is supported.
boolean	supportsProgramOfferingAdmin()	Tests if course offering administrative service is supported.
boolean	supportsProgramOfferingCourseCatalog()	Tests if a program offering cataloging service is supported.
boolean	supportsProgramOfferingCourseCatalogAssignment()	Tests if a program offering cataloging service is supported.
boolean	supportsProgramOfferingLookup()	Tests if looking up program offerings is supported.
boolean	supportsProgramOfferingNotification()	Tests if a program offering notification service is supported.
boolean	supportsProgramOfferingQuery()	Tests if querying program offerings is supported.
boolean	supportsProgramOfferingRecordType(Type programOfferingRecordType)	Tests if the given ProgramOffering record type is supported.
boolean	supportsProgramOfferingSearch()	Tests if searching program offerings is supported.
boolean	supportsProgramOfferingSearchRecordType(Type programOfferingSearchRecordType)	Tests if the given ProgramOffering search record type is supported.
boolean	supportsProgramOfferingSmartCourseCatalog()	Tests if a program offering smart course catalog session is available.
boolean	supportsProgramQuery()	Tests if querying programs is supported.
boolean	supportsProgramRecordType(Type programRecordType)	Tests if the given program record type is supported.
boolean	supportsProgramSearch()	Tests if searching programs is supported.
boolean	supportsProgramSearchRecordType(Type programSearchRecordType)	Tests if the given program search record type is supported.
boolean	supportsProgramSmartCourseCatalog()	Tests if a program smart course catalog session is available.
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

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 {@code supportsProgramLookup()} is {@code 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 {@code supportsProgramLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProgramQuery()} is {@code 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 {@code supportsProgramQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProgramSearch()} is {@code 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 {@code supportsProgramSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProgramAdmin()} is {@code 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 {@code supportsProgramAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProgramNotification()} is {@code 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 {@code supportsProgramNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProgramCourseCatalog()} is {@code 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 {@code supportsProgramCourseCatalogAssignment()} is {@code 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 {@code supportsProgramSmartCourseCatalog()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCourseProgramLookup()} is {@code 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 {@code supportsCourseProgramLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCourseProgramAssignment()} is {@code 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 {@code supportsCourseProgramAssignment()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProgramOfferingLookup()} is {@code 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 {@code supportsProgramOfferingLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProgramOfferingQuery()} is {@code 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 {@code supportsProgramOfferingQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProgramOfferingSearch()} is {@code 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 {@code supportsProgramOfferingSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProgramOfferingAdmin()} is {@code 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 {@code supportsProgramOfferingAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProgramOfferingNotification()} is {@code 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 {@code supportsProgramOfferingNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProgramOfferingCourseCatalog()} is {@code 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 {@code supportsProgramOfferingCourseCatalogAssignment()} is {@code 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 {@code supportsProgramOfferingSmartCourseCatalog()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCredentialLookup()} is {@code 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 {@code supportsCredentialLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCredentialQuery()} is {@code 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 {@code supportsCredentialQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCredentialSearch()} is {@code 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 {@code supportsCredentialSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCourseAdmin()} is {@code 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 {@code supportsCredentialAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCredentialNotification()} is {@code 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 {@code supportsCredentialNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCredentialCourseCatalog()} is {@code 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 {@code supportsCredentialCourseCatalogAssignment()} is {@code 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 {@code supportsCredentialSmartCourseCatalog()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEnrollmentLookup()} is {@code 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 {@code supportsEnrollmentLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEnrollmentQuery()} is {@code 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 {@code supportsEnrollmentQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEnrollmentSearch()} is {@code 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 {@code supportsEnrollmentSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEnrollmentAdmin()} is {@code 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 {@code supportsEnrollmentAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEnrollmentNotification()} is {@code 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 {@code supportsEnrollmentNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEnrollmentCourseCatalog()} is {@code 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 {@code supportsEnrollmentCourseCatalogAssignment()} is {@code 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 {@code supportsEnrollmentSmartCourseCatalog()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCourseProgramBatch()} is {@code true} .