public interface ProgramEntrySmartCourseCatalogSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A ProgramEntryQuery
can be retrieved from this
session and mapped to this CourseCatalog
to create a
virtual collection of ProgramEntries.
The courses may be
sequenced using the ProgramEntrySearchOrder
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 ProgramEntryQueryInspector.
The query may be modified by converting the inspector back to a
ProgramEntryQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyProgramEntryQuery(ProgramEntryQuery programEntryQuery)
Applies a program entry query to this course catalog.
|
void |
applyProgramEntrySequencing(ProgramEntrySearchOrder programEntrySearchOrder)
Applies a program 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. |
ProgramEntryQuery |
getProgramEntryQuery()
Gets a program entry query.
|
ProgramEntryQuery |
getProgramEntryQueryFromInspector(ProgramEntryQueryInspector programEntryQueryInspector)
Gets a program entry query from an inspector.
|
ProgramEntrySearchOrder |
getProgramEntrySearchOrder()
Gets a program entry search order.
|
ProgramEntryQueryInspector |
inspectProgramEntryQuery()
Gets a program 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. ProgramEntryQuery getProgramEntryQuery()
mandatory
- This method must be implemented. ProgramEntrySearchOrder getProgramEntrySearchOrder()
mandatory
- This method must be implemented. void applyProgramEntryQuery(ProgramEntryQuery programEntryQuery) throws OperationFailedException, PermissionDeniedException
programEntryQuery
- the program entry queryNullArgumentException
- programEntryQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- programEntryQuery
not of this servicemandatory
- This method must be implemented. ProgramEntryQueryInspector inspectProgramEntryQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyProgramEntrySequencing(ProgramEntrySearchOrder programEntrySearchOrder) throws OperationFailedException, PermissionDeniedException
programEntrySearchOrder
- the program entry search orderNullArgumentException
- programEntrySearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- programEntrySearchOrder
not of this servicemandatory
- This method must be implemented. ProgramEntryQuery getProgramEntryQueryFromInspector(ProgramEntryQueryInspector programEntryQueryInspector)
programEntryQueryInspector
- a query inspectorNullArgumentException
-
programEntryQueryInspector
is null
UnsupportedException
-
programEntryQueryInspector
is not of this servicemandatory
- This method must be implemented.