public interface SyllabusSmartCourseCatalogSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A SyllabusQuery
can be retrieved from this
session and mapped to this CourseCatalog
to create a
virtual collection of Syllabi.
The docetsmay be sequenced
using the SyllabusSearchOrder
from this session.
This CourseCatalog
has a default query that matches any
syllabus and a default search order that specifies no sequencing. The
queries may be examined using a SyllabusQueryInspector.
The
query may be modified by converting the inspector back to a
SyllabusQuery.
Modifier and Type | Method and Description |
---|---|
void |
applySyllabusQuery(SyllabusQuery syllabusQuery)
Applies a syllabus query to this course catalog.
|
void |
applySyllabusSequencing(SyllabusSearchOrder syllabusSearchOrder)
Applies a syllabus 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. |
SyllabusQuery |
getSyllabusQuery()
Gets a syllabus query.
|
SyllabusQuery |
getSyllabusQueryFromInspector(SyllabusQueryInspector syllabusQueryInspector)
Gets a syllabus query from an inspector.
|
SyllabusSearchOrder |
getSyllabusSearchOrder()
Gets a syllabus search order.
|
SyllabusQueryInspector |
inspectSyllabusQuery()
Gets a syllabus 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. SyllabusQuery getSyllabusQuery()
mandatory
- This method must be implemented. SyllabusSearchOrder getSyllabusSearchOrder()
mandatory
- This method must be implemented. void applySyllabusQuery(SyllabusQuery syllabusQuery) throws OperationFailedException, PermissionDeniedException
syllabusQuery
- the syllabus queryNullArgumentException
- syllabusQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- syllabusQuery
not
of this servicemandatory
- This method must be implemented. SyllabusQueryInspector inspectSyllabusQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applySyllabusSequencing(SyllabusSearchOrder syllabusSearchOrder) throws OperationFailedException, PermissionDeniedException
syllabusSearchOrder
- the syllabus search orderNullArgumentException
- syllabusSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- syllabusSearchOrder
not of this servicemandatory
- This method must be implemented. SyllabusQuery getSyllabusQueryFromInspector(SyllabusQueryInspector syllabusQueryInspector)
syllabusQueryInspector
- a query inspectorNullArgumentException
- syllabusQueryInspector
is null
UnsupportedException
- syllabusQueryInspector
is not of this servicemandatory
- This method must be implemented.