public interface InquestQuerySession extends OsidSession
This session provides methods for searching among Inquest
objects. The search query is constructed using the
InquestQuery.
Inquests may have a query record indicated by their respective record
types. The query record is accessed via the InquestQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchInquests()
Tests if this user can perform
Inquest searches. |
InquestQuery |
getInquestQuery()
Gets an inquest query.
|
InquestList |
getInquestsByQuery(InquestQuery inquestQuery)
Gets a list of
Inquests matching the given inquest
query. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchInquests()
Inquest
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 not offer lookup operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. InquestQuery getInquestQuery()
mandatory
- This method must be implemented. InquestList getInquestsByQuery(InquestQuery inquestQuery) throws OperationFailedException, PermissionDeniedException
Inquests
matching the given inquest
query.inquestQuery
- the inquest query InquestList
NullArgumentException
- inquestQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- inquestQuery
is
not of this servicemandatory
- This method must be implemented.