public interface SyllabusQuerySession extends OsidSession
This session provides methods for searching Syllabus
objects. The search query is constructed using the SyllabusQuery.
The syllabus record Type
also specifies the record
for the docet query.
Syllabi may have a query record indicated by their respective record
types. The query record is accessed via the SyllabusQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchSyllabi()
Tests if this user can perform susbcription searches.
|
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
SyllabusList |
getSyllabiByQuery(SyllabusQuery syllabusQuery)
Gets a list of syllabi matching the given syllabus query.
|
SyllabusQuery |
getSyllabusQuery()
Gets a syllabus 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 canSearchSyllabi()
PERMISSION_DENIED.
This is intended as a hint to an
application that may not wish 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. SyllabusQuery getSyllabusQuery()
mandatory
- This method must be implemented. SyllabusList getSyllabiByQuery(SyllabusQuery syllabusQuery) throws OperationFailedException, PermissionDeniedException
syllabusQuery
- the syllabus query SyllabusList
NullArgumentException
- syllabusQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- syllabusQuery
is
not of this servicemandatory
- This method must be implemented.