public interface RegistrationSmartCourseCatalogSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A RegistrationQuery
can be retrieved from this
session and mapped to this CoursOfferingeCatalog
to create
a virtual collection of Registrations.
The registrations
may be sequenced using the RegistrationSearchOrder
from
this session.
This CourseCatalog
has a default query that matches any
registration and a default search order that specifies no sequencing. The
queries may be examined using a RegistrationQueryInspector.
The query may be modified by converting the inspector back to a
RegistrationQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyRegistrationQuery(RegistrationQuery registrationQuery)
Applies a registration query to this course catalog.
|
void |
applyRegistrationSequencing(RegistrationSearchOrder registrationSearchOrder)
Applies a registration 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. |
RegistrationQuery |
getRegistrationQuery()
Gets a registration query.
|
RegistrationQuery |
getRegistrationQueryFromInspector(RegistrationQueryInspector registrationQueryInspector)
Gets a registration query from an inspector.
|
RegistrationSearchOrder |
getRegistrationSearchOrder()
Gets a registration search order.
|
RegistrationQueryInspector |
inspectRegistrationQuery()
Gets a registration 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. RegistrationQuery getRegistrationQuery()
mandatory
- This method must be implemented. RegistrationSearchOrder getRegistrationSearchOrder()
mandatory
- This method must be implemented. void applyRegistrationQuery(RegistrationQuery registrationQuery) throws OperationFailedException, PermissionDeniedException
registrationQuery
- the registration queryNullArgumentException
- registrationQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- registrationQuery
not of this servicemandatory
- This method must be implemented. RegistrationQueryInspector inspectRegistrationQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyRegistrationSequencing(RegistrationSearchOrder registrationSearchOrder) throws OperationFailedException, PermissionDeniedException
registrationSearchOrder
- the registration search orderNullArgumentException
- registrationSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- registrationSearchOrder
not of this servicemandatory
- This method must be implemented. RegistrationQuery getRegistrationQueryFromInspector(RegistrationQueryInspector registrationQueryInspector)
registrationQueryInspector
- a query inspectorNullArgumentException
-
registrationQueryInspector
is null
UnsupportedException
-
registrationQueryInspector
is not of this servicemandatory
- This method must be implemented.