public interface CourseOfferingSmartCourseCatalogSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A CourseOfferingQuery
can be retrieved from this
session and mapped to this CoursOfferingeCatalog
to create
a virtual collection of CourseOfferings.
The course
offerings may be sequenced using the CourseOfferingSearchOrder
from this session.
This CourseCatalog
has a default query that matches any
course offering and a default search order that specifies no sequencing.
The queries may be examined using a CourseOfferingQueryInspector.
The query may be modified by converting the inspector back to a
CourseOfferingQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyCourseOfferingQuery(CourseOfferingQuery courseOfferingQuery)
Applies a course offering query to this course catalog.
|
void |
applyCourseOfferingSequencing(CourseOfferingSearchOrder courseOfferingSearchOrder)
Applies a course offering 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. |
CourseOfferingQuery |
getCourseOfferingQuery()
Gets a course offering query.
|
CourseOfferingQuery |
getCourseOfferingQueryFromInspector(CourseOfferingQueryInspector courseOfferingQueryInspector)
Gets a course offering query from an inspector.
|
CourseOfferingSearchOrder |
getCourseOfferingSearchOrder()
Gets a course offering search order.
|
CourseOfferingQueryInspector |
inspectCourseOfferingQuery()
Gets a course offering 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. CourseOfferingQuery getCourseOfferingQuery()
mandatory
- This method must be implemented. CourseOfferingSearchOrder getCourseOfferingSearchOrder()
mandatory
- This method must be implemented. void applyCourseOfferingQuery(CourseOfferingQuery courseOfferingQuery) throws OperationFailedException, PermissionDeniedException
courseOfferingQuery
- the course offering queryNullArgumentException
- courseOfferingQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- courseOfferingQuery
not of this servicemandatory
- This method must be implemented. CourseOfferingQueryInspector inspectCourseOfferingQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyCourseOfferingSequencing(CourseOfferingSearchOrder courseOfferingSearchOrder) throws OperationFailedException, PermissionDeniedException
courseOfferingSearchOrder
- the course offering search orderNullArgumentException
-
courseOfferingSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- courseOfferingSearchOrder
not of this servicemandatory
- This method must be implemented. CourseOfferingQuery getCourseOfferingQueryFromInspector(CourseOfferingQueryInspector courseOfferingQueryInspector)
courseOfferingQueryInspector
- a query inspectorNullArgumentException
-
courseOfferingQueryInspector
is null
UnsupportedException
-
courseOfferingQueryInspector
is not of this servicemandatory
- This method must be implemented.