public interface DocetSmartCourseCatalogSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An DocetQuery
can be retrieved from this session
and mapped to this CourseCatalog
to create a virtual
collection of Docets.
The docetsmay be sequenced using the
DocetSearchOrder
from this session.
This CourseCatalog
has a default query that matches any
docet and a default search order that specifies no sequencing. The queries
may be examined using an DocetQueryInspector.
The query may
be modified by converting the inspector back to an DocetQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyDocetQuery(DocetQuery docetQuery)
Applies a docet query to this course catalog.
|
void |
applyDocetSequencing(DocetSearchOrder docetSearchOrder)
Applies a docet 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. |
DocetQuery |
getDocetQuery()
Gets a docet query.
|
DocetQuery |
getDocetQueryFromInspector(DocetQueryInspector docetQueryInspector)
Gets a docet query from an inspector.
|
DocetSearchOrder |
getDocetSearchOrder()
Gets a docet search order.
|
DocetQueryInspector |
inspectDocetQuery()
Gets a docet 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. DocetQuery getDocetQuery()
mandatory
- This method must be implemented. DocetSearchOrder getDocetSearchOrder()
mandatory
- This method must be implemented. void applyDocetQuery(DocetQuery docetQuery) throws OperationFailedException, PermissionDeniedException
docetQuery
- the docet queryNullArgumentException
- docetQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- docetQuery
not of
this servicemandatory
- This method must be implemented. DocetQueryInspector inspectDocetQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyDocetSequencing(DocetSearchOrder docetSearchOrder) throws OperationFailedException, PermissionDeniedException
docetSearchOrder
- the docet search orderNullArgumentException
- docetSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- docetSearchOrder
not of this servicemandatory
- This method must be implemented. DocetQuery getDocetQueryFromInspector(DocetQueryInspector docetQueryInspector)
docetQueryInspector
- a query inspectorNullArgumentException
- docetQueryInspector
is null
UnsupportedException
- docetQueryInspector
is not of this servicemandatory
- This method must be implemented.