public interface PlanSmartCourseCatalogSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A PlanQuery
can be retrieved from this session
and mapped to this CourseCatalog
to create a virtual
collection of Plans.
The lessonsmay be sequenced using the
PlanSearchOrder
from this session.
This CourseCatalog
has a default query that matches any
plan and a default search order that specifies no sequencing. The queries
may be examined using a PlanQueryInspector.
The query may
be modified by converting the inspector back to a PlanQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyPlanQuery(PlanQuery planQuery)
Applies a plan query to this course catalog.
|
void |
applyPlanSequencing(PlanSearchOrder planSearchOrder)
Applies a plan 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. |
PlanQuery |
getPlanQuery()
Gets a plan query.
|
PlanQuery |
getPlanQueryFromInspector(PlanQueryInspector planQueryInspector)
Gets a plan query from an inspector.
|
PlanSearchOrder |
getPlanSearchOrder()
Gets a plan search order.
|
PlanQueryInspector |
inspectPlanQuery()
Gets a plan 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. PlanQuery getPlanQuery()
mandatory
- This method must be implemented. PlanSearchOrder getPlanSearchOrder()
mandatory
- This method must be implemented. void applyPlanQuery(PlanQuery planQuery) throws OperationFailedException, PermissionDeniedException
planQuery
- the plan queryNullArgumentException
- planQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- planQuery
not of
this servicemandatory
- This method must be implemented. PlanQueryInspector inspectPlanQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyPlanSequencing(PlanSearchOrder planSearchOrder) throws OperationFailedException, PermissionDeniedException
planSearchOrder
- the plan search orderNullArgumentException
- planSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- planSearchOrder
not of this servicemandatory
- This method must be implemented. PlanQuery getPlanQueryFromInspector(PlanQueryInspector planQueryInspector)
planQueryInspector
- a query inspectorNullArgumentException
- planQueryInspector
is null
UnsupportedException
- planQueryInspector
is not of this servicemandatory
- This method must be implemented.