public interface SearchSession extends OsidSession
This session provides methods to evaluate and execute search.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearch()
Tests if this user can evaluate search.
|
Engine |
getEngine()
Gets the
Engine associated with this session. |
Id |
getEngineId()
Gets the
Engine Id associated with this
session. |
Query |
getQuery()
Gets the query interface.
|
Query |
getQueryFromInspector(QueryInspector queryInspector)
Gets a query interface from an inspector.
|
Search |
getSearch()
Gets the search interface.
|
SearchResults |
search(Query query,
Search search)
Gets the search results matching the given search query using the
given search.
|
void |
useFederatedEngineView()
Federates the view for methods in this session.
|
void |
useIsolatedEngineView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getEngineId()
Engine
Id
associated with this
session. Engine Id
associated with this sessionmandatory
- This method must be implemented. Engine getEngine() throws OperationFailedException, PermissionDeniedException
Engine
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearch()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations. false
if evaluation methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedEngineView()
mandatory
- This method is must be implemented. void useIsolatedEngineView()
mandatory
- This method is must be implemented. Query getQuery()
Query
interfacemandatory
- This method must be implemented. Search getSearch()
Search
interfacemandatory
- This method must be implemented. SearchResults search(Query query, Search search) throws OperationFailedException, PermissionDeniedException
query
- a rule Id
search
- input conditionsNullArgumentException
- query
or
search
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- query
or
search
not of this servicemandatory
- This method must be implemented. Query getQueryFromInspector(QueryInspector queryInspector)
SearchResults.
queryInspector
- a query inspectorNullArgumentException
- queryInspector
is null
UnsupportedException
- queryInspector
is
not of this servicemandatory
- This method must be implemented.