public interface LessonQuerySession extends OsidSession
This session provides methods for searching Lesson
objects. The search query is constructed using the LessonQuery.
The lesson record Type
also specifies the record
for the lesson query.
Lessons may have a query record indicated by their respective record
types. The query record is accessed via the LessonQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchLessons()
Tests if this user can perform
Lesson searches. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
LessonQuery |
getLessonQuery()
Gets a lesson query.
|
LessonList |
getLessonsByQuery(LessonQuery lessonQuery)
Gets a list of
Lessons matching the given search. |
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 canSearchLessons()
Lesson
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. LessonQuery getLessonQuery()
mandatory
- This method must be implemented. LessonList getLessonsByQuery(LessonQuery lessonQuery) throws OperationFailedException, PermissionDeniedException
Lessons
matching the given search.lessonQuery
- the lesson query LessonList
NullArgumentException
- lessonQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- lessonQuery
is
not of this servicemandatory
- This method must be implemented.