public interface TermQuerySession extends OsidSession
This session provides methods for searching among Term
objects. The search query is constructed using the TermQuery.
This session defines views that offer differing behaviors for searching.
Terms may have a query record indicated by their respective record
types. The query record is accessed via the TermQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchTerms()
Tests if this user can perform
Term lookups. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
TermQuery |
getTermQuery()
Gets a term query.
|
TermList |
getTermsByQuery(TermQuery termQuery)
Gets a list of
Terms matching the given term 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 canSearchTerms()
Term
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. void useFederatedCourseCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCourseCatalogView()
mandatory
- This method is must be implemented. TermQuery getTermQuery()
mandatory
- This method must be implemented. TermList getTermsByQuery(TermQuery termQuery) throws OperationFailedException, PermissionDeniedException
Terms
matching the given term query.termQuery
- the term query TermList
NullArgumentException
- termQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- termQuery
is not
of this servicemandatory
- This method must be implemented.