public interface LessonSmartCourseCatalogSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A LessonQuery
can be retrieved from this session
and mapped to this CourseCatalog
to create a virtual
collection of Lessons.
The lessonsmay be sequenced using
the LessonSearchOrder
from this session.
This CourseCatalog
has a default query that matches any
lesson and a default search order that specifies no sequencing. The
queries may be examined using a LessonQueryInspector.
The
query may be modified by converting the inspector back to a
LessonQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyLessonQuery(LessonQuery lessonQuery)
Applies a lesson query to this course catalog.
|
void |
applyLessonSequencing(LessonSearchOrder lessonSearchOrder)
Applies a lesson 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. |
LessonQuery |
getLessonQuery()
Gets a lesson query.
|
LessonQuery |
getLessonQueryFromInspector(LessonQueryInspector lessonQueryInspector)
Gets a lesson query from an inspector.
|
LessonSearchOrder |
getLessonSearchOrder()
Gets a lesson search order.
|
LessonQueryInspector |
inspectLessonQuery()
Gets a lesson 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. CourseCatalog
associated with this sessionOperationFailedException
- 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. LessonQuery getLessonQuery()
mandatory
- This method must be implemented. LessonSearchOrder getLessonSearchOrder()
mandatory
- This method must be implemented. void applyLessonQuery(LessonQuery lessonQuery) throws OperationFailedException, PermissionDeniedException
lessonQuery
- the lesson queryNullArgumentException
- lessonQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- lessonQuery
not
of this servicemandatory
- This method must be implemented. LessonQueryInspector inspectLessonQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyLessonSequencing(LessonSearchOrder lessonSearchOrder) throws OperationFailedException, PermissionDeniedException
lessonSearchOrder
- the lesson search orderNullArgumentException
- lessonSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- lessonSearchOrder
not of this servicemandatory
- This method must be implemented. LessonQuery getLessonQueryFromInspector(LessonQueryInspector lessonQueryInspector)
lessonQueryInspector
- a query inspectorNullArgumentException
- lessonQueryInspector
is null
UnsupportedException
- lessonQueryInspector
is not of this servicemandatory
- This method must be implemented.