public interface ActivityUnitSmartCourseCatalogSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An ActivityUnitQuery
can be retrieved from this
session and mapped to this CoursOfferingeCatalog
to create
a virtual collection of ActivityUnits.
The activity units
may be sequenced using the ActivityUnitSearchOrder
from
this session.
This CourseCatalog
has a default query that matches any
activity unit and a default search order that specifies no sequencing. The
queries may be examined using an ActivityUnitQueryInspector.
The query may be modified by converting the inspector back to an
ActivityUnitQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyActivityUnitQuery(ActivityUnitQuery activityUnitQuery)
Applies an activity unit query to this course catalog.
|
void |
applyActivityUnitSequencing(ActivityUnitSearchOrder activityUnitSearchOrder)
Applies an activity unit search order to this course catalog.
|
boolean |
canManageSmartCourseCatalogs()
Tests if this user can manage smart course catalogs.
|
ActivityUnitQuery |
getActivityUnitQuery()
Gets an activity unit query.
|
ActivityUnitQuery |
getActivityUnitQueryFromInspector(ActivityUnitQueryInspector activityUnitQueryInspector)
Gets an activity unit query from an inspector.
|
ActivityUnitSearchOrder |
getActivityUnitSearchOrder()
Gets an activity unit search order.
|
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
ActivityUnitQueryInspector |
inspectActivityUnitQuery()
Gets an activity unit 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. ActivityUnitQuery getActivityUnitQuery()
mandatory
- This method must be implemented. ActivityUnitSearchOrder getActivityUnitSearchOrder()
mandatory
- This method must be implemented. void applyActivityUnitQuery(ActivityUnitQuery activityUnitQuery) throws OperationFailedException, PermissionDeniedException
activityUnitQuery
- the activity unit queryNullArgumentException
- activityUnitQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- activityUnitQuery
not of this servicemandatory
- This method must be implemented. ActivityUnitQueryInspector inspectActivityUnitQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyActivityUnitSequencing(ActivityUnitSearchOrder activityUnitSearchOrder) throws OperationFailedException, PermissionDeniedException
activityUnitSearchOrder
- the activity unit search orderNullArgumentException
- activityUnitSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- activityUnitSearchOrder
not of this servicemandatory
- This method must be implemented. ActivityUnitQuery getActivityUnitQueryFromInspector(ActivityUnitQueryInspector activityUnitQueryInspector)
activityUnitQueryInspector
- a query inspectorNullArgumentException
-
activityUnitQueryInspector
is null
UnsupportedException
-
activityUnitQueryInspector
is not of this servicemandatory
- This method must be implemented.