public interface RequisiteSmartCourseCatalogSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A RequisiteQuery
can be retrieved from this
session and mapped to this CourseCatalog
to create a
virtual collection of Requisites.
The courses may be
sequenced using the RequisiteSearchOrder
from this session.
This CourseCatalog
has a default query that matches any
course and a default search order that specifies no sequencing. The
queries may be examined using a RequisiteQueryInspector.
The query may be modified by converting the inspector back to a
RequisiteQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyRequisiteQuery(RequisiteQuery requisiteQuery)
Applies a requisite query to this course catalog.
|
void |
applyRequisiteSequencing(RequisiteSearchOrder requisiteSearchOrder)
Applies a requisite search order to this course catalog.
|
boolean |
canManageSmartCourseCatalogs()
Tests if this user can manage smart course catalogs.
|
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
RequisiteQuery |
getRequisiteQuery()
Gets a requisite query.
|
RequisiteQuery |
getRequisiteQueryFromInspector(RequisiteQueryInspector requisiteQueryInspector)
Gets a requisite query from an inspector.
|
RequisiteSearchOrder |
getRequisiteSearchOrder()
Gets a requisite search order.
|
RequisiteQueryInspector |
inspectRequisiteQuery()
Gets a requisite query inspector for this course catalog.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCourseCatalogId()
CourseCatalog
Id
associated
with this session. CourseCatalog Id
associated with this
sessionmandatory
- This method must be implemented. CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
CourseCatalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartCourseCatalogs()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart course catalog management is not
authorized, true
otherwisemandatory
- This method must be implemented. RequisiteQuery getRequisiteQuery()
mandatory
- This method must be implemented. RequisiteSearchOrder getRequisiteSearchOrder()
mandatory
- This method must be implemented. void applyRequisiteQuery(RequisiteQuery requisiteQuery) throws OperationFailedException, PermissionDeniedException
requisiteQuery
- the requisite queryNullArgumentException
- requisiteQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- requisiteQuery
not of this servicemandatory
- This method must be implemented. RequisiteQueryInspector inspectRequisiteQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyRequisiteSequencing(RequisiteSearchOrder requisiteSearchOrder) throws OperationFailedException, PermissionDeniedException
requisiteSearchOrder
- the requisite search orderNullArgumentException
- requisiteSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- requisiteSearchOrder
not of this servicemandatory
- This method must be implemented. RequisiteQuery getRequisiteQueryFromInspector(RequisiteQueryInspector requisiteQueryInspector)
requisiteQueryInspector
- a query inspectorNullArgumentException
- requisiteQueryInspector
is null
UnsupportedException
- requisiteQueryInspector
is not of this servicemandatory
- This method must be implemented.