public interface ActivityBundleSmartCourseCatalogSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An ActivityBundleQuery
can be retrieved from this
session and mapped to this CoursOfferingeCatalog
to create
a virtual collection of ActivityBundles.
The activity
bundles may be sequenced using the ActivityBundleSearchOrder
from this session.
This CourseCatalog
has a default query that matches any
activity bundle and a default search order that specifies no sequencing.
The queries may be examined using an ActivityBundleQueryInspector.
The query may be modified by converting the inspector back to an
ActivityBundleQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyActivityBundleQuery(ActivityBundleQuery activityBundleQuery)
Applies an activity bundle query to this course catalog.
|
void |
applyActivityBundleSequencing(ActivityBundleSearchOrder activityBundleSearchOrder)
Applies an activity bundle search order to this course catalog.
|
boolean |
canManageSmartCourseCatalogs()
Tests if this user can manage smart course catalogs.
|
ActivityBundleQuery |
getActivityBundleQuery()
Gets an activity bundle query.
|
ActivityBundleQuery |
getActivityBundleQueryFromInspector(ActivityBundleQueryInspector activityBundleQueryInspector)
Gets an activity bundle query from an inspector.
|
ActivityBundleSearchOrder |
getActivityBundleSearchOrder()
Gets an activity bundle search order.
|
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
ActivityBundleQueryInspector |
inspectActivityBundleQuery()
Gets an activity bundle 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. ActivityBundleQuery getActivityBundleQuery()
mandatory
- This method must be implemented. ActivityBundleSearchOrder getActivityBundleSearchOrder()
mandatory
- This method must be implemented. void applyActivityBundleQuery(ActivityBundleQuery activityBundleQuery) throws OperationFailedException, PermissionDeniedException
activityBundleQuery
- the activity bundle queryNullArgumentException
- activityBundleQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- activityBundleQuery
not of this servicemandatory
- This method must be implemented. ActivityBundleQueryInspector inspectActivityBundleQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyActivityBundleSequencing(ActivityBundleSearchOrder activityBundleSearchOrder) throws OperationFailedException, PermissionDeniedException
activityBundleSearchOrder
- the activity bundle search orderNullArgumentException
-
activityBundleSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- activityBundleSearchOrder
not of this servicemandatory
- This method must be implemented. ActivityBundleQuery getActivityBundleQueryFromInspector(ActivityBundleQueryInspector activityBundleQueryInspector)
activityBundleQueryInspector
- a query inspectorNullArgumentException
-
activityBundleQueryInspector
is null
UnsupportedException
-
activityBundleQueryInspector
is not of this servicemandatory
- This method must be implemented.