org.osid.course.requisite

Interface CourseRequisiteManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, CourseRequisiteProfile, OsidManager, OsidProfile, Sourceable

public interface CourseRequisiteManager
extends OsidManager, CourseRequisiteProfile

The course requisite manager provides access to course requisite sessions and provides interoperability tests for various aspects of this service. 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

Methods

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

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.course.requisite.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

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getRequisiteLookupSession

RequisiteLookupSession getRequisiteLookupSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the requisite lookup service.

Returns:

a RequisiteLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteLookup() is false

Compliance:

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

getRequisiteLookupSessionForCourseCatalog

RequisiteLookupSession getRequisiteLookupSessionForCourseCatalog(Id courseCatalogId)
                                                                 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

Returns:

a RequisiteLookupSession

Throws:

NotFoundException - no CourseCatalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteLookup() or supportsVisibleFederation() is false

Compliance:

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

getRequisiteQuerySession

RequisiteQuerySession getRequisiteQuerySession()
                                               throws OperationFailedException

Gets the OsidSession associated with the requisite query service.

Returns:

a RequisiteQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteQuery() is false

Compliance:

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

getRequisiteQuerySessionForCourseCatalog

RequisiteQuerySession getRequisiteQuerySessionForCourseCatalog(Id courseCatalogId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a RequisiteQuerySession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteQuery() or supportsVisibleFederation() is false

Compliance:

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

getRequisiteSearchSession

RequisiteSearchSession getRequisiteSearchSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the requisite search service.

Returns:

a RequisiteSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteSearch() is false

Compliance:

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

getRequisiteSearchSessionForCourseCatalog

RequisiteSearchSession getRequisiteSearchSessionForCourseCatalog(Id courseCatalogId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a RequisiteSearchSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteSearch() or supportsVisibleFederation() is false

Compliance:

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

getRequisiteAdminSession

RequisiteAdminSession getRequisiteAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the requisite administration service.

Returns:

a RequisiteAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteAdmin() is false

Compliance:

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

getRequisiteAdminSessionForCourseCatalog

RequisiteAdminSession getRequisiteAdminSessionForCourseCatalog(Id courseCatalogId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a RequisiteAdminSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteAdmin() or supportsVisibleFederation() is false

Compliance:

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

getRequisiteNotificationSession

RequisiteNotificationSession getRequisiteNotificationSession(RequisiteReceiver requisiteReceiver)
                                                             throws OperationFailedException

Gets the OsidSession associated with the requisite notification service.

Parameters:

requisiteReceiver - the notification callback

Returns:

a RequisiteNotificationSession

Throws:

NullArgumentException - requisiteReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteNotification() is false

Compliance:

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

getRequisiteNotificationSessionForCourseCatalog

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

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

Parameters:

requisiteReceiver - the notification callback

courseCatalogId - the Id of the CourseCatalog

Returns:

a RequisiteNotificationSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - requisiteReceiver or courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteNotification() or supportsVisibleFederation() is false

Compliance:

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

getRequisiteCourseCatalogSession

RequisiteCourseCatalogSession getRequisiteCourseCatalogSession()
                                                               throws OperationFailedException

Gets the OsidSession to lookup requisite/catalog mappings.

Returns:

a RequisiteCourseCatalogSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteCourseCatalog() is false

Compliance:

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

getRequisiteCourseCatalogAssignmentSession

RequisiteCourseCatalogAssignmentSession getRequisiteCourseCatalogAssignmentSession()
                                                                                   throws OperationFailedException

Gets the OsidSession associated with assigning requisites to course catalogs.

Returns:

a RequisiteCourseCatalogAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteCourseCatalogAssignment() is false

Compliance:

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

getRequisiteSmartCourseCatalogSession

RequisiteSmartCourseCatalogSession getRequisiteSmartCourseCatalogSession(Id courseCatalogId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

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

Parameters:

courseCatalogId - the Id of the CourseCatalog

Returns:

a RequisiteSmartCourseCatalogSession

Throws:

NotFoundException - no course catalog found by the given Id

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequisiteSmartCourseCatalog() or supportsVisibleFederation() is false

Compliance:

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