public interface CourseEntrySmartCourseCatalogSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A CourseEntryQuery
can be retrieved from this
session and mapped to this CourseCatalog
to create a
virtual collection of CourseEntries.
The courses may be
sequenced using the CourseEntrySearchOrder
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 CourseEntryQueryInspector.
The query may be modified by converting the inspector back to a
CourseEntryQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyCourseEntryQuery(CourseEntryQuery courseEntryQuery)
Applies a course entry query to this course catalog.
|
void |
applyCourseEntrySequencing(CourseEntrySearchOrder courseEntrySearchOrder)
Applies a course entry 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. |
CourseEntryQuery |
getCourseEntryQuery()
Gets a course entry query.
|
CourseEntryQuery |
getCourseEntryQueryFromInspector(CourseEntryQueryInspector courseEntryQueryInspector)
Gets a course entry query from an inspector.
|
CourseEntrySearchOrder |
getCourseEntrySearchOrder()
Gets a course entry search order.
|
CourseEntryQueryInspector |
inspectCourseEntryQuery()
Gets a course entry 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. CourseEntryQuery getCourseEntryQuery()
mandatory
- This method must be implemented. CourseEntrySearchOrder getCourseEntrySearchOrder()
mandatory
- This method must be implemented. void applyCourseEntryQuery(CourseEntryQuery courseEntryQuery) throws OperationFailedException, PermissionDeniedException
courseEntryQuery
- the course entry queryNullArgumentException
- courseEntryQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- courseEntryQuery
not of this servicemandatory
- This method must be implemented. CourseEntryQueryInspector inspectCourseEntryQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyCourseEntrySequencing(CourseEntrySearchOrder courseEntrySearchOrder) throws OperationFailedException, PermissionDeniedException
courseEntrySearchOrder
- the course entry search orderNullArgumentException
- courseEntrySearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- courseEntrySearchOrder
not of this servicemandatory
- This method must be implemented. CourseEntryQuery getCourseEntryQueryFromInspector(CourseEntryQueryInspector courseEntryQueryInspector)
courseEntryQueryInspector
- a query inspectorNullArgumentException
-
courseEntryQueryInspector
is null
UnsupportedException
- courseEntryQueryInspector
is not of this servicemandatory
- This method must be implemented.