public interface CourseSmartCourseCatalogSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A CourseQuery
can be retrieved from this session
and mapped to this CourseCatalog
to create a virtual
collection of Courses.
The courses may be sequenced using
the CourseSearchOrder
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 CourseQueryInspector.
The
query may be modified by converting the inspector back to a
CourseQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyCourseQuery(CourseQuery courseQuery)
Applies a course query to this course catalog.
|
void |
applyCourseSequencing(CourseSearchOrder courseSearchOrder)
Applies a course 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. |
CourseQuery |
getCourseQuery()
Gets a course query.
|
CourseQuery |
getCourseQueryFromInspector(CourseQueryInspector courseQueryInspector)
Gets a course query from an inspector.
|
CourseSearchOrder |
getCourseSearchOrder()
Gets a course search order.
|
CourseQueryInspector |
inspectCourseQuery()
Gets a course 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. CourseQuery getCourseQuery()
mandatory
- This method must be implemented. CourseSearchOrder getCourseSearchOrder()
mandatory
- This method must be implemented. void applyCourseQuery(CourseQuery courseQuery) throws OperationFailedException, PermissionDeniedException
courseQuery
- the course queryNullArgumentException
- courseQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- courseQuery
not
of this servicemandatory
- This method must be implemented. CourseQueryInspector inspectCourseQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyCourseSequencing(CourseSearchOrder courseSearchOrder) throws OperationFailedException, PermissionDeniedException
courseSearchOrder
- the course search orderNullArgumentException
- courseSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- courseSearchOrder
not of this servicemandatory
- This method must be implemented. CourseQuery getCourseQueryFromInspector(CourseQueryInspector courseQueryInspector)
courseQueryInspector
- a query inspectorNullArgumentException
- courseQueryInspector
is null
UnsupportedException
- courseQueryInspector
is not of this servicemandatory
- This method must be implemented.