Interface CourseRequisiteProxyManager

All Superinterfaces:

AutoCloseable, Closeable, CourseRequisiteProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface CourseRequisiteProxyManager
extends OsidProxyManager, CourseRequisiteProfile

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

• RequisiteLookupSession : a session to retrieve requisites
• RequisiteQuerySession : a session to query requisites
• RequisiteSearchSession : a session to search for requisites
• RequisiteAdminSession : a session to create and delete requisites
• RequisiteNotificationSession : a session to receive notifications pertaining to requisite changes
• RequisiteCourseCatalogSession : a session to look up requisite to course catalog mappings
• RequisiteCourseCatalogAssignmentSession : a session to manage requisite to course catalog mappings
• RequisiteSmartCourseCatalogSession : a session to manage dynamic course catalogs of requisites

Method Summary

Modifier and Type	Method	Description
RequisiteAdminSession	getRequisiteAdminSession(Proxy proxy)	Gets the OsidSession associated with the requisite administration service.
RequisiteAdminSession	getRequisiteAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the requisite administration service for the given course catalog.
RequisiteCourseCatalogAssignmentSession	getRequisiteCourseCatalogAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning requisites to course catalogs.
RequisiteCourseCatalogSession	getRequisiteCourseCatalogSession(Proxy proxy)	Gets the OsidSession to lookup requisite/catalog mappings.
RequisiteLookupSession	getRequisiteLookupSession(Proxy proxy)	Gets the OsidSession associated with the requisite lookup service.
RequisiteLookupSession	getRequisiteLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the requisite lookup service for the given course catalog.
RequisiteNotificationSession	getRequisiteNotificationSession(RequisiteReceiver requisiteReceiver, Proxy proxy)	Gets the OsidSession associated with the requisite notification service.
RequisiteNotificationSession	getRequisiteNotificationSessionForCourseCatalog(RequisiteReceiver requisiteReceiver, Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the requisite notification service for the given course catalog.
RequisiteQuerySession	getRequisiteQuerySession(Proxy proxy)	Gets the OsidSession associated with the requisite query service.
RequisiteQuerySession	getRequisiteQuerySessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the requisite query service for the given course catalog.
RequisiteSearchSession	getRequisiteSearchSession(Proxy proxy)	Gets the OsidSession associated with the requisite search service.
RequisiteSearchSession	getRequisiteSearchSessionForCourseCatalog(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the requisite search service for the given course catalog.
RequisiteSmartCourseCatalogSession	getRequisiteSmartCourseCatalogSession(Id courseCatalogId, Proxy proxy)	Gets the OsidSession associated with the requisite smart course catalog service.

Methods inherited from interface Closeable

close

Methods inherited from interface CourseRequisiteProfile

getAssessmentRequirementRecordTypes, getAwardRequirementRecordTypes, getCourseRequirementRecordTypes, getCredentialRequirementRecordTypes, getLearningObjectiveRequirementRecordTypes, getProgramRequirementRecordTypes, getRequisiteRecordTypes, getRequisiteSearchRecordTypes, supportsAssessmentRequirementRecordType, supportsAwardRequirementRecordType, supportsCourseRequirementRecordType, supportsCredentialRequirementRecordType, supportsLearningObjectiveRequirementRecordType, supportsProgramRequirementRecordType, supportsRequisiteAdmin, supportsRequisiteCourseCatalog, supportsRequisiteCourseCatalogAssignment, supportsRequisiteLookup, supportsRequisiteNotification, supportsRequisiteQuery, supportsRequisiteRecordType, supportsRequisiteSearch, supportsRequisiteSearchRecordType, supportsRequisiteSmartCourseCatalog, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getAssessmentRequirementRecordTypes()	Gets the supported AsessmentRequirement record types.
TypeList	getAwardRequirementRecordTypes()	Gets the supported AsessmentRequirement record types.
TypeList	getCourseRequirementRecordTypes()	Gets the supported CourseRequirement record types.
TypeList	getCredentialRequirementRecordTypes()	Gets the supported CredentialRequirement record types.
TypeList	getLearningObjectiveRequirementRecordTypes()	Gets the supported LearningObjectiveRequirement record types.
TypeList	getProgramRequirementRecordTypes()	Gets the supported ProgramRequirement record types.
TypeList	getRequisiteRecordTypes()	Gets the supported Requisite record types.
TypeList	getRequisiteSearchRecordTypes()	Gets the supported Requisite search record types.
boolean	supportsAssessmentRequirementRecordType(Type assessmentRequirementRecordType)	Tests if the given AsessmentRequirement record type is supported.
boolean	supportsAwardRequirementRecordType(Type awardRequirementRecordType)	Tests if the given AsessmentRequirement record type is supported.
boolean	supportsCourseRequirementRecordType(Type courseRequirementRecordType)	Tests if the given CourseRequirement record type is supported.
boolean	supportsCredentialRequirementRecordType(Type credentialRequirementRecordType)	Tests if the given CredentialRequirement record type is supported.
boolean	supportsLearningObjectiveRequirementRecordType(Type learningObjectiveRequirementRecordType)	Tests if the given LearningObjectiveRequirement record type is supported.
boolean	supportsProgramRequirementRecordType(Type programRequirementRecordType)	Tests if the given ProgramRequirement record type is supported.
boolean	supportsRequisiteAdmin()	Tests if requisite administrative service is supported.
boolean	supportsRequisiteCourseCatalog()	Tests if a requisite cataloging service is supported.
boolean	supportsRequisiteCourseCatalogAssignment()	Tests if a course cataloging service is supported.
boolean	supportsRequisiteLookup()	Tests if looking up requisites is supported.
boolean	supportsRequisiteNotification()	Tests if a requisite notification service is supported.
boolean	supportsRequisiteQuery()	Tests if querying requisites is supported.
boolean	supportsRequisiteRecordType(Type requisiteRecordType)	Tests if the given Requisite record type is supported.
boolean	supportsRequisiteSearch()	Tests if searching requisites is supported.
boolean	supportsRequisiteSearchRecordType(Type requisiteSearchRecordType)	Tests if the given Requisite search record type is supported.
boolean	supportsRequisiteSmartCourseCatalog()	Tests if a requisite 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

getRequisiteLookupSession

RequisiteLookupSession getRequisiteLookupSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the requisite lookup service.

Parameters:

proxy - proxy

Returns:

a RequisiteLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteLookup() is false

Compliance:

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

getRequisiteLookupSessionForCourseCatalog

RequisiteLookupSession getRequisiteLookupSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the course catalog

proxy - proxy

Returns:

a RequisiteLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteLookup() or supportsVisibleFederation() is false

Compliance:

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

getRequisiteQuerySession

RequisiteQuerySession getRequisiteQuerySession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the requisite query service.

Parameters:

proxy - proxy

Returns:

a RequisiteQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteQuery() is false

Compliance:

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

getRequisiteQuerySessionForCourseCatalog

RequisiteQuerySession getRequisiteQuerySessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a RequisiteQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteQuery() or supportsVisibleFederation() is false

Compliance:

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

getRequisiteSearchSession

RequisiteSearchSession getRequisiteSearchSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the requisite search service.

Parameters:

proxy - proxy

Returns:

a RequisiteSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteSearch() is false

Compliance:

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

getRequisiteSearchSessionForCourseCatalog

RequisiteSearchSession getRequisiteSearchSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a RequisiteSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteSearch() or supportsVisibleFederation() is false

Compliance:

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

getRequisiteAdminSession

RequisiteAdminSession getRequisiteAdminSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the requisite administration service.

Parameters:

proxy - proxy

Returns:

a RequisiteAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteAdmin() is false

Compliance:

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

getRequisiteAdminSessionForCourseCatalog

RequisiteAdminSession getRequisiteAdminSessionForCourseCatalog(Id courseCatalogId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a RequisiteAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - proxy or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteAdmin() or supportsVisibleFederation() is false

Compliance:

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

getRequisiteNotificationSession

RequisiteNotificationSession getRequisiteNotificationSession(RequisiteReceiver requisiteReceiver,
 Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the requisite notification service.

Parameters:

requisiteReceiver - the notification callback

proxy - proxy

Returns:

a RequisiteNotificationSession

Throws:

NullArgumentException - requisiteReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteNotification() is false

Compliance:

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

getRequisiteNotificationSessionForCourseCatalog

RequisiteNotificationSession getRequisiteNotificationSessionForCourseCatalog(RequisiteReceiver requisiteReceiver,
 Id courseCatalogId,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

requisiteReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a RequisiteNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - requisiteReceiver, courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteNotification() or supportsVisibleFederation() is false

Compliance:

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

getRequisiteCourseCatalogSession

RequisiteCourseCatalogSession getRequisiteCourseCatalogSession(Proxy proxy)
                                                        throws OperationFailedException

Gets the OsidSession to lookup requisite/catalog mappings.

Parameters:

proxy - proxy

Returns:

a RequisiteCourseCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteCourseCatalog() is false

Compliance:

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

getRequisiteCourseCatalogAssignmentSession

RequisiteCourseCatalogAssignmentSession getRequisiteCourseCatalogAssignmentSession(Proxy proxy)
                                                                            throws OperationFailedException

Gets the OsidSession associated with assigning requisites to course catalogs.

Parameters:

proxy - proxy

Returns:

a RequisiteCourseCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteCourseCatalogAssignment() is false

Compliance:

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

getRequisiteSmartCourseCatalogSession

RequisiteSmartCourseCatalogSession getRequisiteSmartCourseCatalogSession(Id courseCatalogId,
 Proxy proxy)
                                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

proxy - proxy

Returns:

a RequisiteSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteSmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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