public interface ModuleSmartCourseCatalogSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A ModuleQuery
can be retrieved from this session
and mapped to this CourseCatalog
to create a virtual
collection of Modules.
The docetsmay be sequenced using the
ModuleSearchOrder
from this session.
This CourseCatalog
has a default query that matches any
module and a default search order that specifies no sequencing. The
queries may be examined using a ModuleQueryInspector.
The
query may be modified by converting the inspector back to a
ModuleQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyModuleQuery(ModuleQuery moduleQuery)
Applies a module query to this course catalog.
|
void |
applyModuleSequencing(ModuleSearchOrder moduleSearchOrder)
Applies a module 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. |
ModuleQuery |
getModuleQuery()
Gets a module query.
|
ModuleQuery |
getModuleQueryFromInspector(ModuleQueryInspector moduleQueryInspector)
Gets a module query from an inspector.
|
ModuleSearchOrder |
getModuleSearchOrder()
Gets a module search order.
|
ModuleQueryInspector |
inspectModuleQuery()
Gets a module 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. ModuleQuery getModuleQuery()
mandatory
- This method must be implemented. ModuleSearchOrder getModuleSearchOrder()
mandatory
- This method must be implemented. void applyModuleQuery(ModuleQuery moduleQuery) throws OperationFailedException, PermissionDeniedException
moduleQuery
- the module queryNullArgumentException
- moduleQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- moduleQuery
not
of this servicemandatory
- This method must be implemented. ModuleQueryInspector inspectModuleQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyModuleSequencing(ModuleSearchOrder moduleSearchOrder) throws OperationFailedException, PermissionDeniedException
moduleSearchOrder
- the module search orderNullArgumentException
- moduleSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- moduleSearchOrder
not of this servicemandatory
- This method must be implemented. ModuleQuery getModuleQueryFromInspector(ModuleQueryInspector moduleQueryInspector)
moduleQueryInspector
- a query inspectorNullArgumentException
- moduleQueryInspector
is null
UnsupportedException
- moduleQueryInspector
is not of this servicemandatory
- This method must be implemented.