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 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. |
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
RequisiteLookupSession getRequisiteLookupSession() throws OperationFailedException
OsidSession
associated with the requisite
lookup service. RequisiteLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteLookup()
is false
optional
- This method must be implemented if
supportsRequisiteLookup()
is true.
RequisiteLookupSession getRequisiteLookupSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the requisite
lookup service for the given course catalog.courseCatalogId
- the Id
of the course catalog RequisiteLookupSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRequisiteLookup()
and
supportsVisibleFederation()
are true
RequisiteQuerySession getRequisiteQuerySession() throws OperationFailedException
OsidSession
associated with the requisite
query service. RequisiteQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteQuery()
is false
optional
- This method must be implemented if
supportsRequisiteQuery()
is true.
RequisiteQuerySession getRequisiteQuerySessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the requisite
query service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
RequisiteQuerySession
NotFoundException
- no course catalog found by the
given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRequisiteQuery()
and
supportsVisibleFederation()
are true
RequisiteSearchSession getRequisiteSearchSession() throws OperationFailedException
OsidSession
associated with the requisite
search service. RequisiteSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteSearch()
is false
optional
- This method must be implemented if
supportsRequisiteSearch()
is true.
RequisiteSearchSession getRequisiteSearchSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the requisite
search service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
RequisiteSearchSession
NotFoundException
- no course catalog found by the
given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRequisiteSearch()
and
supportsVisibleFederation()
are true
RequisiteAdminSession getRequisiteAdminSession() throws OperationFailedException
OsidSession
associated with the requisite
administration service. RequisiteAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteAdmin()
is false
optional
- This method must be implemented if
supportsRequisiteAdmin()
is true.
RequisiteAdminSession getRequisiteAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the requisite
administration service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
RequisiteAdminSession
NotFoundException
- no course catalog found by the
given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRequisiteAdmin()
and
supportsVisibleFederation()
are true
RequisiteNotificationSession getRequisiteNotificationSession(RequisiteReceiver requisiteReceiver) throws OperationFailedException
OsidSession
associated with the requisite
notification service.requisiteReceiver
- the notification callback RequisiteNotificationSession
NullArgumentException
- requisiteReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteNotification()
is false
optional
- This method must be implemented if
supportsRequisiteNotification()
is true.
RequisiteNotificationSession getRequisiteNotificationSessionForCourseCatalog(RequisiteReceiver requisiteReceiver, Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the course
notification service for the given course catalog.requisiteReceiver
- the notification callbackcourseCatalogId
- the Id
of the
CourseCatalog
RequisiteNotificationSession
NotFoundException
- no course catalog found by the
given Id
NullArgumentException
- requisiteReceiver
or courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRequisiteNotification()
and
supportsVisibleFederation()
are true
RequisiteCourseCatalogSession getRequisiteCourseCatalogSession() throws OperationFailedException
OsidSession
to lookup requisite/catalog
mappings. RequisiteCourseCatalogSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteCourseCatalog()
is false
optional
- This method must be implemented if
supportsRequisiteCourseCatalog()
is true.
RequisiteCourseCatalogAssignmentSession getRequisiteCourseCatalogAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning
requisites to course catalogs. RequisiteCourseCatalogAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteCourseCatalogAssignment()
is
false
optional
- This method must be implemented if
supportsRequisiteCourseCatalogAssignment()
is
true.
RequisiteSmartCourseCatalogSession getRequisiteSmartCourseCatalogSession(Id courseCatalogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the requisite
smart course catalog service.courseCatalogId
- the Id
of the
CourseCatalog
RequisiteSmartCourseCatalogSession
NotFoundException
- no course catalog found by the
given Id
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteSmartCourseCatalog()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRequisiteSmartCourseCatalog()
and
supportsVisibleFederation()
are true