public interface ModuleQuerySession extends OsidSession
This session provides methods for searching Module
objects. The search query is constructed using the ModuleQuery.
The docet record Type
also specifies the record for
the docet query.
Modules may have a query record indicated by their respective record
types. The query record is accessed via the ModuleQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchModules()
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. |
ModuleQuery |
getModuleQuery()
Gets a module query.
|
ModuleList |
getModulesByQuery(ModuleQuery moduleQuery)
Gets a list of modules matching the given module 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 canSearchModules()
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. ModuleQuery getModuleQuery()
mandatory
- This method must be implemented. ModuleList getModulesByQuery(ModuleQuery moduleQuery) throws OperationFailedException, PermissionDeniedException
moduleQuery
- the module query ModuleList
NullArgumentException
- moduleQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- moduleQuery
is
not of this servicemandatory
- This method must be implemented.