public interface CourseCatalogQuerySession extends OsidSession
This session provides methods for searching among CourseCatalog
objects. The search query is constructed using the
CourseCatalogQuery.
This session defines views that offer differing behaviors for searching.
Course catalogs may have a query record indicated by their respective
record types. The query record is accessed via the
CourseCatalogQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchCourseCatalogs()
Tests if this user can perform
CourseCatalog lookups. |
CourseCatalogQuery |
getCourseCatalogQuery()
Gets a course catalog query.
|
CourseCatalogList |
getCourseCatalogsByQuery(CourseCatalogQuery courseCatalogQuery)
Gets a list of
CourseCatalogs matching the given course
catalog query. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchCourseCatalogs()
CourseCatalog
lookups. 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 not offer lookup operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. CourseCatalogQuery getCourseCatalogQuery()
mandatory
- This method must be implemented. CourseCatalogList getCourseCatalogsByQuery(CourseCatalogQuery courseCatalogQuery) throws OperationFailedException, PermissionDeniedException
CourseCatalogs
matching the given course
catalog query.courseCatalogQuery
- the course catalog query CourseCatalogList
NullArgumentException
- courseCatalogQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- courseCatalogQuery
is not of this servicemandatory
- This method must be implemented.