public interface CourseQuerySession extends OsidSession
This session provides methods for searching among Course
objects. The search query is constructed using the CourseQuery.
This session defines views that offer differing behaviors for searching.
Courses may have a query record indicated by their respective record
types. The query record is accessed via the CourseQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchCourses()
Tests if this user can perform
Course searches. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
CourseQuery |
getCourseQuery()
Gets a course query.
|
CourseList |
getCoursesByQuery(CourseQuery courseQuery)
Gets a list of
Courses matching the given course query. |
void |
useFederatedCourseCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCourseCatalogView()
Isolates the view for methods in this session.
|
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 canSearchCourses()
Course
searches. A
return of true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this session will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may opt not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedCourseCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCourseCatalogView()
mandatory
- This method is must be implemented. CourseQuery getCourseQuery()
mandatory
- This method must be implemented. CourseList getCoursesByQuery(CourseQuery courseQuery) throws OperationFailedException, PermissionDeniedException
Courses
matching the given course query.courseQuery
- the course query CourseList
NullArgumentException
- courseQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- courseQuery
is
not of this servicemandatory
- This method must be implemented.