Interface CourseChronicleProxyManager

All Superinterfaces:

AutoCloseable, Closeable, CourseChronicleProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface CourseChronicleProxyManager
extends OsidProxyManager, CourseChronicleProfile

The course chronicle manager provides access to course chronicle 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:

• AcademicRecordSession : a session to look at a student academic record
• ProgramEntryLookupSession : a session to retrieve program entries
• ProgramEntryQuerySession : a session to query program entries
• ProgramEntrySearchSession : a session to search for program entries
• ProgramEntryAdminSession : a session to create and delete program entries
• ProgramEntryNotificationSession : a session to receive notifications pertaining to program entry changes
• ProgramEntryCourseCatalogSession : a session to look up program entry to course catalog mappings
• ProgramEntryCourseCatalogAssignmentSession : a session to manage program entry to course catalog mappings
• ProgramEntrySmartCourseCatalogSession : a session to manage dynamic course catalogs of program entries

• CourseEntryLookupSession : a session to retrieve course entries
• CourseEntryQuerySession : a session to query course entries
• CourseEntrySearchSession : a session to search for course entries
• CourseEntryAdminSession : a session to create and delete course entries
• CourseEntryNotificationSession : a session to receive notifications pertaining to course entry changes
• CourseEntryCourseCatalogSession : a session to look up course entry to course catalog mappings
• CourseEntryCourseCatalogAssignmentSession : a session to manage course entry to course catalog mappings
• CourseEntrySmartCourseCatalogSession : a session to manage dynamic course catalogs of course entries

• CredentialEntryLookupSession : a session to retrieve credential entries
• CredentialEntryQuerySession : a session to query credential entries
• CredentialEntrySearchSession : a session to search for credential entries
• CredentialEntryAdminSession : a session to create and delete credential entries
• CredentialEntryNotificationSession : a session to receive notifications pertaining to credential entry changes
• CredentialEntryCourseCatalogSession : a session to look up credential entry to course catalog mappings
• CredentialEntryCourseCatalogAssignmentSession : a session to manage credential entry to course catalog mappings
• CredentialEntrySmartCourseCatalogSession : a session to manage dynamic course catalogs of credential entries

• AssessmentEntryLookupSession : a session to retrieve assessment entries
• AssessmentEntryQuerySession : a session to query assessment entries
• AssessmentEntrySearchSession : a session to search for assessment entries
• AssessmentEntryAdminSession : a session to create and delete assessment entries
• AssessmentEntryNotificationSession : a session to receive notifications pertaining to assessment entry changes
• AssessmentEntryCourseCatalogSession : a session to look up assessment entry to course catalog mappings
• AssessmentEntryCourseCatalogAssignmentSession : a session to manage assessment entry to course catalog mappings
• AssessmentEntrySmartCourseCatalogSession : a session to manage dynamic course catalogs of assessment entries

• AwardEntryLookupSession : a session to retrieve award entries
• AwardEntryQuerySession : a session to query award entries
• AwardEntrySearchSession : a session to search for award entries
• AwardEntryAdminSession : a session to create and delete award entries
• AwardEntryNotificationSession : a session to receive notifications pertaining to award entry changes
• AwardEntryCourseCatalogSession : a session to look up award entry to course catalog mappings
• AwardEntryCourseCatalogAssignmentSession : a session to manage award entry to course catalog mappings
• AwardEntrySmartCourseCatalogSession : a session to manage dynamic course catalogs of award entries

Method Summary

Modifier and Type	Method	Description
AcademicRecordSession	getAcademicRecordSession(Proxy proxy)	Gets the OsidSession associated with the academic record service.
AcademicRecordSession	getAcademicRecordSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the academic record service for the given course catalog.
AssessmentEntryAdminSession	getAssessmentEntryAdminSession(Proxy proxy)	Gets the OsidSession associated with the assessment entry administration service.
AssessmentEntryAdminSession	getAssessmentEntryAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the assessment entry administration service for the given course catalog.
AssessmentEntryCourseCatalogAssignmentSession	getAssessmentEntryCourseCatalogAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning assessment entries to course catalogs.
AssessmentEntryCourseCatalogSession	getAssessmentEntryCourseCatalogSession(Proxy proxy)	Gets the OsidSession to lookup assessment entry/catalog mappings.
AssessmentEntryLookupSession	getAssessmentEntryLookupSession(Proxy proxy)	Gets the OsidSession associated with the assessment entry lookup service.
AssessmentEntryLookupSession	getAssessmentEntryLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the assessment entry lookup service for the given course catalog.
AssessmentEntryNotificationSession	getAssessmentEntryNotificationSession(AssessmentEntryReceiver assessmentEntryReceiver, Proxy proxy)	Gets the OsidSession associated with the assessment entry notification service.
AssessmentEntryNotificationSession	getAssessmentEntryNotificationSessionForCourseCatalog(AssessmentEntryReceiver assessmentEntryReceiver, Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the assessment entry notification service for the given course catalog.
AssessmentEntryQuerySession	getAssessmentEntryQuerySession(Proxy proxy)	Gets the OsidSession associated with the assessment entry query service.
AssessmentEntryQuerySession	getAssessmentEntryQuerySessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the assessment entry query service for the given course catalog.
AssessmentEntrySearchSession	getAssessmentEntrySearchSession(Proxy proxy)	Gets the OsidSession associated with the assessment entry search service.
AssessmentEntrySearchSession	getAssessmentEntrySearchSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the assessment entry search service for the given course catalog.
AssessmentEntrySmartCourseCatalogSession	getAssessmentEntrySmartCourseCatalogSession(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the assessment entry smart course catalog service.
AwardEntryAdminSession	getAwardEntryAdminSession(Proxy proxy)	Gets the OsidSession associated with the award entry administration service.
AwardEntryAdminSession	getAwardEntryAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the award entry administration service for the given course catalog.
AwardEntryCourseCatalogAssignmentSession	getAwardEntryCourseCatalogAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning award entries to course catalogs.
AwardEntryCourseCatalogSession	getAwardEntryCourseCatalogSession(Proxy proxy)	Gets the OsidSession to lookup award entry/catalog mappings.
AwardEntryLookupSession	getAwardEntryLookupSession(Proxy proxy)	Gets the OsidSession associated with the award entry lookup service.
AwardEntryLookupSession	getAwardEntryLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the award entry lookup service for the given course catalog.
AwardEntryNotificationSession	getAwardEntryNotificationSession(AwardEntryReceiver awardEntryReceiver, Proxy proxy)	Gets the OsidSession associated with the award entry notification service.
AwardEntryNotificationSession	getAwardEntryNotificationSessionForCourseCatalog(AwardEntryReceiver awardEntryReceiver, Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the award entry notification service for the given course catalog.
AwardEntryQuerySession	getAwardEntryQuerySession(Proxy proxy)	Gets the OsidSession associated with the award entry query service.
AwardEntryQuerySession	getAwardEntryQuerySessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the award entry query service for the given course catalog.
AwardEntrySearchSession	getAwardEntrySearchSession(Proxy proxy)	Gets the OsidSession associated with the award entry search service.
AwardEntrySearchSession	getAwardEntrySearchSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the award entry search service for the given course catalog.
AwardEntrySmartCourseCatalogSession	getAwardEntrySmartCourseCatalogSession(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the award entry smart course catalog service.
CourseChronicleBatchProxyManager	getCourseChronicleBatchProxyManager()	Gets the CourseChronicleBatchProxyManager .
CourseEntryAdminSession	getCourseEntryAdminSession(Proxy proxy)	Gets the OsidSession associated with the course entry administration service.
CourseEntryAdminSession	getCourseEntryAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the course entry administration service for the given course catalog.
CourseEntryCourseCatalogAssignmentSession	getCourseEntryCourseCatalogAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning course entries to course catalogs.
CourseEntryCourseCatalogSession	getCourseEntryCourseCatalogSession(Proxy proxy)	Gets the OsidSession to lookup course entry/catalog mappings.
CourseEntryLookupSession	getCourseEntryLookupSession(Proxy proxy)	Gets the OsidSession associated with the course entry lookup service.
CourseEntryLookupSession	getCourseEntryLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the course entry lookup service for the given course catalog.
CourseEntryNotificationSession	getCourseEntryNotificationSession(CourseEntryReceiver courseEntryReceiver, Proxy proxy)	Gets the OsidSession associated with the course entry notification service.
CourseEntryNotificationSession	getCourseEntryNotificationSessionForCourseCatalog(CourseEntryReceiver courseEntryReceiver, Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the course entry notification service for the given course catalog.
CourseEntryQuerySession	getCourseEntryQuerySession(Proxy proxy)	Gets the OsidSession associated with the course entry query service.
CourseEntryQuerySession	getCourseEntryQuerySessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the course entry query service for the given course catalog.
CourseEntrySearchSession	getCourseEntrySearchSession(Proxy proxy)	Gets the OsidSession associated with the course entry search service.
CourseEntrySearchSession	getCourseEntrySearchSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the course entry search service for the given course catalog.
CourseEntrySmartCourseCatalogSession	getCourseEntrySmartCourseCatalogSession(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the course entry smart course catalog service.
CredentialEntryAdminSession	getCredentialEntryAdminSession(Proxy proxy)	Gets the OsidSession associated with the credential entry administration service.
CredentialEntryAdminSession	getCredentialEntryAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the credential entry administration service for the given course catalog.
CredentialEntryCourseCatalogAssignmentSession	getCredentialEntryCourseCatalogAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning credential entries to course catalogs.
CredentialEntryCourseCatalogSession	getCredentialEntryCourseCatalogSession(Proxy proxy)	Gets the OsidSession to lookup credential entry/catalog mappings.
CredentialEntryLookupSession	getCredentialEntryLookupSession(Proxy proxy)	Gets the OsidSession associated with the credential entry lookup service.
CredentialEntryLookupSession	getCredentialEntryLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the credential entry lookup service for the given course catalog.
CredentialEntryNotificationSession	getCredentialEntryNotificationSession(CredentialEntryReceiver credentialEntryReceiver, Proxy proxy)	Gets the OsidSession associated with the credential entry notification service.
CredentialEntryNotificationSession	getCredentialEntryNotificationSessionForCourseCatalog(CredentialEntryReceiver credentialEntryReceiver, Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the credential entry notification service for the given course catalog.
CredentialEntryQuerySession	getCredentialEntryQuerySession(Proxy proxy)	Gets the OsidSession associated with the credential entry query service.
CredentialEntryQuerySession	getCredentialEntryQuerySessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the credential entry query service for the given course catalog.
CredentialEntrySearchSession	getCredentialEntrySearchSession(Proxy proxy)	Gets the OsidSession associated with the credential entry search service.
CredentialEntrySearchSession	getCredentialEntrySearchSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the credential entry search service for the given course catalog.
CredentialEntrySmartCourseCatalogSession	getCredentialEntrySmartCourseCatalogSession(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the credential entry smart course catalog service.
ProgramEntryAdminSession	getProgramEntryAdminSession(Proxy proxy)	Gets the OsidSession associated with the program entry administration service.
ProgramEntryAdminSession	getProgramEntryAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the program entry administration service for the given course catalog.
ProgramEntryCourseCatalogAssignmentSession	getProgramEntryCourseCatalogAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning program entries to course catalogs.
ProgramEntryCourseCatalogSession	getProgramEntryCourseCatalogSession(Proxy proxy)	Gets the OsidSession to lookup program entry/catalog mappings.
ProgramEntryLookupSession	getProgramEntryLookupSession(Proxy proxy)	Gets the OsidSession associated with the program entry lookup service.
ProgramEntryLookupSession	getProgramEntryLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the program entry lookup service for the given course catalog.
ProgramEntryNotificationSession	getProgramEntryNotificationSession(ProgramEntryReceiver programEntryReceiver, Proxy proxy)	Gets the OsidSession associated with the program entry notification service.
ProgramEntryNotificationSession	getProgramEntryNotificationSessionForCourseCatalog(ProgramEntryReceiver programEntryReceiver, Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the program entry notification service for the given course catalog.
ProgramEntryQuerySession	getProgramEntryQuerySession(Proxy proxy)	Gets the OsidSession associated with the program entry query service.
ProgramEntryQuerySession	getProgramEntryQuerySessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the program entry query service for the given course catalog.
ProgramEntrySearchSession	getProgramEntrySearchSession(Proxy proxy)	Gets the OsidSession associated with the program entry search service.
ProgramEntrySearchSession	getProgramEntrySearchSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the program entry search service for the given course catalog.
ProgramEntrySmartCourseCatalogSession	getProgramEntrySmartCourseCatalogSession(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the program entry smart course catalog service.

Methods inherited from interface Closeable

close

Methods inherited from interface CourseChronicleProfile

getAssessmentEntryRecordTypes, getAssessmentEntrySearchRecordTypes, getAwardEntryRecordTypes, getAwardEntrySearchRecordTypes, getCourseEntryRecordTypes, getCourseEntrySearchRecordTypes, getCredentialEntryRecordTypes, getCredentialEntrySearchRecordTypes, getProgramEntryRecordTypes, getProgramEntrySearchRecordTypes, supportsAcademicRecord, supportsAssessmentEntryAdmin, supportsAssessmentEntryCourseCatalog, supportsAssessmentEntryCourseCatalogAssignment, supportsAssessmentEntryLookup, supportsAssessmentEntryNotification, supportsAssessmentEntryQuery, supportsAssessmentEntryRecordType, supportsAssessmentEntrySearch, supportsAssessmentEntrySearchRecordType, supportsAssessmentEntrySmartCourseCatalog, supportsAwardEntryAdmin, supportsAwardEntryCourseCatalog, supportsAwardEntryCourseCatalogAssignment, supportsAwardEntryLookup, supportsAwardEntryNotification, supportsAwardEntryQuery, supportsAwardEntryRecordType, supportsAwardEntrySearch, supportsAwardEntrySearchRecordType, supportsAwardEntrySmartCourseCatalog, supportsCourseChronicalBatch, supportsCourseEntryAdmin, supportsCourseEntryCourseCatalog, supportsCourseEntryCourseCatalogAssignment, supportsCourseEntryLookup, supportsCourseEntryNotification, supportsCourseEntryQuery, supportsCourseEntryRecordType, supportsCourseEntrySearch, supportsCourseEntrySearchRecordType, supportsCourseEntrySmartCourseCatalog, supportsCredentialEntryAdmin, supportsCredentialEntryCourseCatalog, supportsCredentialEntryCourseCatalogAssignment, supportsCredentialEntryLookup, supportsCredentialEntryNotification, supportsCredentialEntryQuery, supportsCredentialEntryRecordType, supportsCredentialEntrySearch, supportsCredentialEntrySearchRecordType, supportsCredentialEntrySmartCourseCatalog, supportsProgramEntryAdmin, supportsProgramEntryCourseCatalog, supportsProgramEntryCourseCatalogAssignment, supportsProgramEntryLookup, supportsProgramEntryNotification, supportsProgramEntryQuery, supportsProgramEntryRecordType, supportsProgramEntrySearch, supportsProgramEntrySearchRecordType, supportsProgramEntrySmartCourseCatalog, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getAssessmentEntryRecordTypes()	Gets the supported AssessmentEntry record types.
TypeList	getAssessmentEntrySearchRecordTypes()	Gets the supported AssessmentEntry search record types.
TypeList	getAwardEntryRecordTypes()	Gets the supported AwardEntry record types.
TypeList	getAwardEntrySearchRecordTypes()	Gets the supported AwardEntry search record types.
TypeList	getCourseEntryRecordTypes()	Gets the supported CourseEntry record types.
TypeList	getCourseEntrySearchRecordTypes()	Gets the supported CourseEntry search record types.
TypeList	getCredentialEntryRecordTypes()	Gets the supported CredentialEntry record types.
TypeList	getCredentialEntrySearchRecordTypes()	Gets the supported CredentialEntry search record types.
TypeList	getProgramEntryRecordTypes()	Gets the supported ProgramEntry record types.
TypeList	getProgramEntrySearchRecordTypes()	Gets the supported ProgramEntry search record types.
boolean	supportsAcademicRecord()	Tests if retrieving an academic record is supported.
boolean	supportsAssessmentEntryAdmin()	Tests if assessment entry administrative service is supported.
boolean	supportsAssessmentEntryCourseCatalog()	Tests if an assessment entry cataloging service is supported.
boolean	supportsAssessmentEntryCourseCatalogAssignment()	Tests if a course cataloging service is supported.
boolean	supportsAssessmentEntryLookup()	Tests if looking up assessment entries is supported.
boolean	supportsAssessmentEntryNotification()	Tests if an assessment entry notification service is supported.
boolean	supportsAssessmentEntryQuery()	Tests if querying assessment entries is supported.
boolean	supportsAssessmentEntryRecordType(Type assessmentEntryRecordType)	Tests if the given AssessmentEntry record type is supported.
boolean	supportsAssessmentEntrySearch()	Tests if searching assessment entries is supported.
boolean	supportsAssessmentEntrySearchRecordType(Type assessmentEntrySearchRecordType)	Tests if the given AssessmentEntry search record type is supported.
boolean	supportsAssessmentEntrySmartCourseCatalog()	Tests if an assessment entry smart course catalog session is available.
boolean	supportsAwardEntryAdmin()	Tests if award entry administrative service is supported.
boolean	supportsAwardEntryCourseCatalog()	Tests if an award entry cataloging service is supported.
boolean	supportsAwardEntryCourseCatalogAssignment()	Tests if a course cataloging service is supported.
boolean	supportsAwardEntryLookup()	Tests if looking up award entries is supported.
boolean	supportsAwardEntryNotification()	Tests if an award entry notification service is supported.
boolean	supportsAwardEntryQuery()	Tests if querying award entries is supported.
boolean	supportsAwardEntryRecordType(Type awardEntryRecordType)	Tests if the given AwardEntry record type is supported.
boolean	supportsAwardEntrySearch()	Tests if searching award entries is supported.
boolean	supportsAwardEntrySearchRecordType(Type awardEntrySearchRecordType)	Tests if the given AwardEntry search record type is supported.
boolean	supportsAwardEntrySmartCourseCatalog()	Tests if an award entry smart course catalog session is available.
boolean	supportsCourseChronicalBatch()	Tests if a course chronicle batch service is available.
boolean	supportsCourseEntryAdmin()	Tests if course entry administrative service is supported.
boolean	supportsCourseEntryCourseCatalog()	Tests if a course entry cataloging service is supported.
boolean	supportsCourseEntryCourseCatalogAssignment()	Tests if a course cataloging service is supported.
boolean	supportsCourseEntryLookup()	Tests if looking up course entries is supported.
boolean	supportsCourseEntryNotification()	Tests if a course entry notification service is supported.
boolean	supportsCourseEntryQuery()	Tests if querying course entries is supported.
boolean	supportsCourseEntryRecordType(Type courseEntryRecordType)	Tests if the given CourseEntry record type is supported.
boolean	supportsCourseEntrySearch()	Tests if searching course entries is supported.
boolean	supportsCourseEntrySearchRecordType(Type courseEntrySearchRecordType)	Tests if the given CourseEntry search record type is supported.
boolean	supportsCourseEntrySmartCourseCatalog()	Tests if a course entry smart course catalog session is available.
boolean	supportsCredentialEntryAdmin()	Tests if credential entry administrative service is supported.
boolean	supportsCredentialEntryCourseCatalog()	Tests if a credential entry cataloging service is supported.
boolean	supportsCredentialEntryCourseCatalogAssignment()	Tests if a course cataloging service is supported.
boolean	supportsCredentialEntryLookup()	Tests if looking up credential entries is supported.
boolean	supportsCredentialEntryNotification()	Tests if a credential entry notification service is supported.
boolean	supportsCredentialEntryQuery()	Tests if querying credential entries is supported.
boolean	supportsCredentialEntryRecordType(Type credentialEntryRecordType)	Tests if the given CredentialEntry record type is supported.
boolean	supportsCredentialEntrySearch()	Tests if searching credential entries is supported.
boolean	supportsCredentialEntrySearchRecordType(Type credentialEntrySearchRecordType)	Tests if the given CredentialEntry search record type is supported.
boolean	supportsCredentialEntrySmartCourseCatalog()	Tests if a credential entry smart course catalog session is available.
boolean	supportsProgramEntryAdmin()	Tests if program entry administrative service is supported.
boolean	supportsProgramEntryCourseCatalog()	Tests if a program entry cataloging service is supported.
boolean	supportsProgramEntryCourseCatalogAssignment()	Tests if a course cataloging service is supported.
boolean	supportsProgramEntryLookup()	Tests if looking up program entries is supported.
boolean	supportsProgramEntryNotification()	Tests if a program entry notification service is supported.
boolean	supportsProgramEntryQuery()	Tests if querying program entries is supported.
boolean	supportsProgramEntryRecordType(Type programEntryRecordType)	Tests if the given ProgramEntry record type is supported.
boolean	supportsProgramEntrySearch()	Tests if searching program entries is supported.
boolean	supportsProgramEntrySearchRecordType(Type programEntrySearchRecordType)	Tests if the given ProgramEntry search record type is supported.
boolean	supportsProgramEntrySmartCourseCatalog()	Tests if a program entry 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

getAcademicRecordSession

AcademicRecordSession getAcademicRecordSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the academic record service.

Parameters:

proxy - proxy

Returns:

an AcademicRecordSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAcademicRecord() is false

Compliance:

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

getAcademicRecordSessionForCourseCatalog

AcademicRecordSession getAcademicRecordSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the academic record service for the given course catalog.

Parameters:

courseCatalogId - the Id of the course catalog

proxy - proxy

Returns:

an AcademicRecordSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAcademicRecord() or supportsVisibleFederation() is false

Compliance:

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

getProgramEntryLookupSession

ProgramEntryLookupSession getProgramEntryLookupSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the program entry lookup service.

Parameters:

proxy - proxy

Returns:

a ProgramEntryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramEntryLookup() is false

Compliance:

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

getProgramEntryLookupSessionForCourseCatalog

ProgramEntryLookupSession getProgramEntryLookupSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

proxy - proxy

Returns:

a ProgramEntryLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramEntryLookup() or supportsVisibleFederation() is false

Compliance:

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

getProgramEntryQuerySession

ProgramEntryQuerySession getProgramEntryQuerySession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the program entry query service.

Parameters:

proxy - proxy

Returns:

a ProgramEntryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramEntryQuery() is false

Compliance:

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

getProgramEntryQuerySessionForCourseCatalog

ProgramEntryQuerySession getProgramEntryQuerySessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                              throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a ProgramEntryQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramEntryQuery() or supportsVisibleFederation() is false

Compliance:

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

getProgramEntrySearchSession

ProgramEntrySearchSession getProgramEntrySearchSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the program entry search service.

Parameters:

proxy - proxy

Returns:

a ProgramEntrySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramEntrySearch() is false

Compliance:

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

getProgramEntrySearchSessionForCourseCatalog

ProgramEntrySearchSession getProgramEntrySearchSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a ProgramEntrySearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramEntrySearch() or supportsVisibleFederation() is false

Compliance:

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

getProgramEntryAdminSession

ProgramEntryAdminSession getProgramEntryAdminSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the program entry administration service.

Parameters:

proxy - proxy

Returns:

a ProgramEntryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramEntryAdmin() is false

Compliance:

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

getProgramEntryAdminSessionForCourseCatalog

ProgramEntryAdminSession getProgramEntryAdminSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                              throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a ProgramEntryAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramEntryAdmin() or supportsVisibleFederation() is false

Compliance:

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

getProgramEntryNotificationSession

ProgramEntryNotificationSession getProgramEntryNotificationSession(ProgramEntryReceiver programEntryReceiver,
 Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the program entry notification service.

Parameters:

programEntryReceiver - the notification callback

proxy - proxy

Returns:

a ProgramEntryNotificationSession

Throws:

NullArgumentException - programEntryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramEntryNotification() is false

Compliance:

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

getProgramEntryNotificationSessionForCourseCatalog

ProgramEntryNotificationSession getProgramEntryNotificationSessionForCourseCatalog(ProgramEntryReceiver programEntryReceiver,
 Id courseCatalogId,
 Proxy proxy)
                                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

programEntryReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a ProgramEntryNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - programEntryReceiver, courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramEntryNotification() or supportsVisibleFederation() is false

Compliance:

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

getProgramEntryCourseCatalogSession

ProgramEntryCourseCatalogSession getProgramEntryCourseCatalogSession(Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession to lookup program entry/catalog mappings.

Parameters:

proxy - proxy

Returns:

a ProgramEntryCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramEntryCourseCatalog() is false

Compliance:

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

getProgramEntryCourseCatalogAssignmentSession

ProgramEntryCourseCatalogAssignmentSession getProgramEntryCourseCatalogAssignmentSession(Proxy proxy)
                                                                                  throws OperationFailedException

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

Parameters:

proxy - proxy

Returns:

a ProgramEntryCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramEntryCourseCatalogAssignment() is false

Compliance:

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

getProgramEntrySmartCourseCatalogSession

ProgramEntrySmartCourseCatalogSession getProgramEntrySmartCourseCatalogSession(Id courseCatalogId,
 Proxy proxy)
                                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a ProgramEntrySmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProgramEntrySmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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

getCourseEntryLookupSession

CourseEntryLookupSession getCourseEntryLookupSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the course entry lookup service.

Parameters:

proxy - proxy

Returns:

a CourseEntryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseEntryLookup() is false

Compliance:

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

getCourseEntryLookupSessionForCourseCatalog

CourseEntryLookupSession getCourseEntryLookupSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                              throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

proxy - proxy

Returns:

a CourseEntryLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseEntryLookup() or supportsVisibleFederation() is false

Compliance:

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

getCourseEntryQuerySession

CourseEntryQuerySession getCourseEntryQuerySession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the course entry query service.

Parameters:

proxy - proxy

Returns:

a CourseEntryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseEntryQuery() is false

Compliance:

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

getCourseEntryQuerySessionForCourseCatalog

CourseEntryQuerySession getCourseEntryQuerySessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CourseEntryQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseEntryQuery() or supportsVisibleFederation() is false

Compliance:

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

getCourseEntrySearchSession

CourseEntrySearchSession getCourseEntrySearchSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the course entry search service.

Parameters:

proxy - proxy

Returns:

a CourseEntrySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseEntrySearch() is false

Compliance:

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

getCourseEntrySearchSessionForCourseCatalog

CourseEntrySearchSession getCourseEntrySearchSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                              throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CourseEntrySearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseEntrySearch() or supportsVisibleFederation() is false

Compliance:

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

getCourseEntryAdminSession

CourseEntryAdminSession getCourseEntryAdminSession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the course entry administration service.

Parameters:

proxy - proxy

Returns:

a CourseEntryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseEntryAdmin() is false

Compliance:

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

getCourseEntryAdminSessionForCourseCatalog

CourseEntryAdminSession getCourseEntryAdminSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CourseEntryAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseEntryAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCourseEntryNotificationSession

CourseEntryNotificationSession getCourseEntryNotificationSession(CourseEntryReceiver courseEntryReceiver,
 Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the course entry notification service.

Parameters:

courseEntryReceiver - the notification callback

proxy - proxy

Returns:

a CourseEntryNotificationSession

Throws:

NullArgumentException - courseEntryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseEntryNotification() is false

Compliance:

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

getCourseEntryNotificationSessionForCourseCatalog

CourseEntryNotificationSession getCourseEntryNotificationSessionForCourseCatalog(CourseEntryReceiver courseEntryReceiver,
 Id courseCatalogId,
 Proxy proxy)
                                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

courseEntryReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CourseEntryNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseEntryReceiver, courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseEntryNotification() or supportsVisibleFederation() is false

Compliance:

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

getCourseEntryCourseCatalogSession

CourseEntryCourseCatalogSession getCourseEntryCourseCatalogSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession to lookup course entry/catalog mappings.

Parameters:

proxy - proxy

Returns:

a CourseEntryCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseEntryCourseCatalog() is false

Compliance:

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

getCourseEntryCourseCatalogAssignmentSession

CourseEntryCourseCatalogAssignmentSession getCourseEntryCourseCatalogAssignmentSession(Proxy proxy)
                                                                                throws OperationFailedException

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

Parameters:

proxy - proxy

Returns:

a CourseEntryCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseEntryCourseCatalogAssignment() is false

Compliance:

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

getCourseEntrySmartCourseCatalogSession

CourseEntrySmartCourseCatalogSession getCourseEntrySmartCourseCatalogSession(Id courseCatalogId,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CourseEntrySmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseEntrySmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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

getCredentialEntryLookupSession

CredentialEntryLookupSession getCredentialEntryLookupSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the credential entry lookup service.

Parameters:

proxy - proxy

Returns:

a CredentialEntryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialEntryLookup() is false

Compliance:

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

getCredentialEntryLookupSessionForCourseCatalog

CredentialEntryLookupSession getCredentialEntryLookupSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

proxy - proxy

Returns:

a CredentialEntryLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialEntryLookup() or supportsVisibleFederation() is false

Compliance:

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

getCredentialEntryQuerySession

CredentialEntryQuerySession getCredentialEntryQuerySession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the credential entry query service.

Parameters:

proxy - proxy

Returns:

a CredentialEntryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialEntryQuery() is false

Compliance:

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

getCredentialEntryQuerySessionForCourseCatalog

CredentialEntryQuerySession getCredentialEntryQuerySessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CredentialEntryQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialEntryQuery() or supportsVisibleFederation() is false

Compliance:

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

getCredentialEntrySearchSession

CredentialEntrySearchSession getCredentialEntrySearchSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the credential entry search service.

Parameters:

proxy - proxy

Returns:

a CredentialEntrySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialEntrySearch() is false

Compliance:

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

getCredentialEntrySearchSessionForCourseCatalog

CredentialEntrySearchSession getCredentialEntrySearchSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CredentialEntrySearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialEntrySearch() or supportsVisibleFederation() is false

Compliance:

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

getCredentialEntryAdminSession

CredentialEntryAdminSession getCredentialEntryAdminSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the credential entry administration service.

Parameters:

proxy - proxy

Returns:

a CredentialEntryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialEntryAdmin() is false

Compliance:

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

getCredentialEntryAdminSessionForCourseCatalog

CredentialEntryAdminSession getCredentialEntryAdminSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CredentialEntryAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialEntryAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCredentialEntryNotificationSession

CredentialEntryNotificationSession getCredentialEntryNotificationSession(CredentialEntryReceiver credentialEntryReceiver,
 Proxy proxy)
                                                                  throws OperationFailedException

Gets the OsidSession associated with the credential entry notification service.

Parameters:

credentialEntryReceiver - the notification callback

proxy - proxy

Returns:

a CredentialEntryNotificationSession

Throws:

NullArgumentException - credentialEntryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialEntryNotification() is false

Compliance:

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

getCredentialEntryNotificationSessionForCourseCatalog

CredentialEntryNotificationSession getCredentialEntryNotificationSessionForCourseCatalog(CredentialEntryReceiver credentialEntryReceiver,
 Id courseCatalogId,
 Proxy proxy)
                                                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

credentialEntryReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CredentialEntryNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - credentialEntryReceiver, courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialEntryNotification() or supportsVisibleFederation() is false

Compliance:

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

getCredentialEntryCourseCatalogSession

CredentialEntryCourseCatalogSession getCredentialEntryCourseCatalogSession(Proxy proxy)
                                                                    throws OperationFailedException

Gets the OsidSession to lookup credential entry/catalog mappings.

Parameters:

proxy - proxy

Returns:

a CredentialEntryCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialEntryCourseCatalog() is false

Compliance:

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

getCredentialEntryCourseCatalogAssignmentSession

CredentialEntryCourseCatalogAssignmentSession getCredentialEntryCourseCatalogAssignmentSession(Proxy proxy)
                                                                                        throws OperationFailedException

Gets the OsidSession associated with assigning credential entries to course catalogs.

Parameters:

proxy - proxy

Returns:

a CredentialEntryCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialEntryCourseCatalogAssignment() is false

Compliance:

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

getCredentialEntrySmartCourseCatalogSession

CredentialEntrySmartCourseCatalogSession getCredentialEntrySmartCourseCatalogSession(Id courseCatalogId,
 Proxy proxy)
                                                                              throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a CredentialEntrySmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCredentialEntrySmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentEntryLookupSession

AssessmentEntryLookupSession getAssessmentEntryLookupSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the assessment entry lookup service.

Parameters:

proxy - proxy

Returns:

an AssessmentEntryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentEntryLookup() is false

Compliance:

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

getAssessmentEntryLookupSessionForCourseCatalog

AssessmentEntryLookupSession getAssessmentEntryLookupSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

proxy - proxy

Returns:

an AssessmentEntryLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentEntryLookup() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentEntryQuerySession

AssessmentEntryQuerySession getAssessmentEntryQuerySession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the assessment entry query service.

Parameters:

proxy - proxy

Returns:

an AssessmentEntryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentEntryQuery() is false

Compliance:

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

getAssessmentEntryQuerySessionForCourseCatalog

AssessmentEntryQuerySession getAssessmentEntryQuerySessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an AssessmentEntryQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentEntryQuery() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentEntrySearchSession

AssessmentEntrySearchSession getAssessmentEntrySearchSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the assessment entry search service.

Parameters:

proxy - proxy

Returns:

an AssessmentEntrySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentEntrySearch() is false

Compliance:

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

getAssessmentEntrySearchSessionForCourseCatalog

AssessmentEntrySearchSession getAssessmentEntrySearchSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an AssessmentEntrySearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentEntrySearch() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentEntryAdminSession

AssessmentEntryAdminSession getAssessmentEntryAdminSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the assessment entry administration service.

Parameters:

proxy - proxy

Returns:

an AssessmentEntryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentEntryAdmin() is false

Compliance:

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

getAssessmentEntryAdminSessionForCourseCatalog

AssessmentEntryAdminSession getAssessmentEntryAdminSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an AssessmentEntryAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentEntryAdmin() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentEntryNotificationSession

AssessmentEntryNotificationSession getAssessmentEntryNotificationSession(AssessmentEntryReceiver assessmentEntryReceiver,
 Proxy proxy)
                                                                  throws OperationFailedException

Gets the OsidSession associated with the assessment entry notification service.

Parameters:

assessmentEntryReceiver - the notification callback

proxy - proxy

Returns:

an AssessmentEntryNotificationSession

Throws:

NullArgumentException - assessmentEntryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentEntryNotification() is false

Compliance:

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

getAssessmentEntryNotificationSessionForCourseCatalog

AssessmentEntryNotificationSession getAssessmentEntryNotificationSessionForCourseCatalog(AssessmentEntryReceiver assessmentEntryReceiver,
 Id courseCatalogId,
 Proxy proxy)
                                                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

assessmentEntryReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an AssessmentEntryNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - assessmentEntryReceiver, courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentEntryNotification() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentEntryCourseCatalogSession

AssessmentEntryCourseCatalogSession getAssessmentEntryCourseCatalogSession(Proxy proxy)
                                                                    throws OperationFailedException

Gets the OsidSession to lookup assessment entry/catalog mappings.

Parameters:

proxy - proxy

Returns:

an AssessmentEntryCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentEntryCourseCatalog() is false

Compliance:

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

getAssessmentEntryCourseCatalogAssignmentSession

AssessmentEntryCourseCatalogAssignmentSession getAssessmentEntryCourseCatalogAssignmentSession(Proxy proxy)
                                                                                        throws OperationFailedException

Gets the OsidSession associated with assigning assessment entries to course catalogs.

Parameters:

proxy - proxy

Returns:

an AssessmentEntryCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentEntryCourseCatalogAssignment() is false

Compliance:

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

getAssessmentEntrySmartCourseCatalogSession

AssessmentEntrySmartCourseCatalogSession getAssessmentEntrySmartCourseCatalogSession(Id courseCatalogId,
 Proxy proxy)
                                                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the assessment entry smart course catalog service.

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an AssessmentEntrySmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentEntrySmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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

getAwardEntryLookupSession

AwardEntryLookupSession getAwardEntryLookupSession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the award entry lookup service.

Parameters:

proxy - proxy

Returns:

an AwardEntryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardEntryLookup() is false

Compliance:

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

getAwardEntryLookupSessionForCourseCatalog

AwardEntryLookupSession getAwardEntryLookupSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

proxy - proxy

Returns:

an AwardEntryLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardEntryLookup() or supportsVisibleFederation() is false

Compliance:

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

getAwardEntryQuerySession

AwardEntryQuerySession getAwardEntryQuerySession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the award entry query service.

Parameters:

proxy - proxy

Returns:

an AwardEntryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardEntryQuery() is false

Compliance:

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

getAwardEntryQuerySessionForCourseCatalog

AwardEntryQuerySession getAwardEntryQuerySessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an AwardEntryQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardEntryQuery() or supportsVisibleFederation() is false

Compliance:

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

getAwardEntrySearchSession

AwardEntrySearchSession getAwardEntrySearchSession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the award entry search service.

Parameters:

proxy - proxy

Returns:

an AwardEntrySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardEntrySearch() is false

Compliance:

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

getAwardEntrySearchSessionForCourseCatalog

AwardEntrySearchSession getAwardEntrySearchSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an AwardEntrySearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardEntrySearch() or supportsVisibleFederation() is false

Compliance:

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

getAwardEntryAdminSession

AwardEntryAdminSession getAwardEntryAdminSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the award entry administration service.

Parameters:

proxy - proxy

Returns:

an AwardEntryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardEntryAdmin() is false

Compliance:

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

getAwardEntryAdminSessionForCourseCatalog

AwardEntryAdminSession getAwardEntryAdminSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an AwardEntryAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardEntryAdmin() or supportsVisibleFederation() is false

Compliance:

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

getAwardEntryNotificationSession

AwardEntryNotificationSession getAwardEntryNotificationSession(AwardEntryReceiver awardEntryReceiver,
 Proxy proxy)
                                                        throws OperationFailedException

Gets the OsidSession associated with the award entry notification service.

Parameters:

awardEntryReceiver - the notification callback

proxy - proxy

Returns:

an AwardEntryNotificationSession

Throws:

NullArgumentException - awardEntryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardEntryNotification() is false

Compliance:

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

getAwardEntryNotificationSessionForCourseCatalog

AwardEntryNotificationSession getAwardEntryNotificationSessionForCourseCatalog(AwardEntryReceiver awardEntryReceiver,
 Id courseCatalogId,
 Proxy proxy)
                                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

awardEntryReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an AwardEntryNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - awardEntryReceiver, courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardEntryNotification() or supportsVisibleFederation() is false

Compliance:

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

getAwardEntryCourseCatalogSession

AwardEntryCourseCatalogSession getAwardEntryCourseCatalogSession(Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession to lookup award entry/catalog mappings.

Parameters:

proxy - proxy

Returns:

an AwardEntryCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardEntryCourseCatalog() is false

Compliance:

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

getAwardEntryCourseCatalogAssignmentSession

AwardEntryCourseCatalogAssignmentSession getAwardEntryCourseCatalogAssignmentSession(Proxy proxy)
                                                                              throws OperationFailedException

Gets the OsidSession associated with assigning award entries to course catalogs.

Parameters:

proxy - proxy

Returns:

an AwardEntryCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardEntryCourseCatalogAssignment() is false

Compliance:

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

getAwardEntrySmartCourseCatalogSession

AwardEntrySmartCourseCatalogSession getAwardEntrySmartCourseCatalogSession(Id courseCatalogId,
 Proxy proxy)
                                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the award entry smart course catalog service.

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

an AwardEntrySmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAwardEntrySmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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

getCourseChronicleBatchProxyManager

CourseChronicleBatchProxyManager getCourseChronicleBatchProxyManager()
                                                              throws OperationFailedException

Gets the CourseChronicleBatchProxyManager .

Returns:

a CourseChronicleBatcProxyhManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCourseChronicleBatchProxyManager() is false

Compliance:

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