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 Modifier and Type | Method and 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. |
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the requisite
lookup service.proxy
- proxy RequisiteLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteLookup()
is false
optional
- This method must be implemented if
supportsRequisiteLookup()
is true.
RequisiteLookupSession getRequisiteLookupSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the requisite
lookup service for the given course catalog.courseCatalogId
- the Id
of the course catalogproxy
- proxy RequisiteLookupSession
NotFoundException
- no CourseCatalog
found by the given Id
NullArgumentException
- proxy
or
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the requisite
query service.proxy
- proxy RequisiteQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteQuery()
is false
optional
- This method must be implemented if
supportsRequisiteQuery()
is true.
RequisiteQuerySession getRequisiteQuerySessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the requisite
query service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
proxy
- proxy RequisiteQuerySession
NotFoundException
- no course catalog found by the
given Id
NullArgumentException
- proxy
or
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the requisite
search service.proxy
- proxy RequisiteSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteSearch()
is false
optional
- This method must be implemented if
supportsRequisiteSearch()
is true.
RequisiteSearchSession getRequisiteSearchSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the requisite
search service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
proxy
- proxy RequisiteSearchSession
NotFoundException
- no course catalog found by the
given Id
NullArgumentException
- proxy
or
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the requisite
administration service.proxy
- proxy RequisiteAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteAdmin()
is false
optional
- This method must be implemented if
supportsRequisiteAdmin()
is true.
RequisiteAdminSession getRequisiteAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the requisite
administration service for the given course catalog.courseCatalogId
- the Id
of the
CourseCatalog
proxy
- proxy RequisiteAdminSession
NotFoundException
- no course catalog found by the
given Id
NullArgumentException
- proxy
or
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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the requisite
notification service.requisiteReceiver
- the notification callbackproxy
- proxy RequisiteNotificationSession
NullArgumentException
- requisiteReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the requisite
notification service for the given course catalog.requisiteReceiver
- the notification callbackcourseCatalogId
- the Id
of the
CourseCatalog
proxy
- proxy RequisiteNotificationSession
NotFoundException
- no course catalog found by the
given Id
NullArgumentException
- requisiteReceiver,
courseCatalogId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
to lookup requisite/catalog
mappings.proxy
- proxy RequisiteCourseCatalogSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteCourseCatalog()
is false
optional
- This method must be implemented if
supportsRequisiteCourseCatalog()
is true.
RequisiteCourseCatalogAssignmentSession getRequisiteCourseCatalogAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning
requisites to course catalogs.proxy
- proxy RequisiteCourseCatalogAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteCourseCatalogAssignment()
is
false
optional
- This method must be implemented if
supportsRequisiteCourseCatalogAssignment()
is
true.
RequisiteSmartCourseCatalogSession getRequisiteSmartCourseCatalogSession(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the requisite
smart course catalog service.courseCatalogId
- the Id
of the
CourseCatalog
proxy
- proxy RequisiteSmartCourseCatalogSession
NotFoundException
- no course catalog found by the
given Id
NullArgumentException
- courseCatalogId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequisiteSmartCourseCatalog()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRequisiteSmartCourseCatalog()
and
supportsVisibleFederation()
are true