public interface ResultQuerySession extends OsidSession
This session provides methods for querying Result
objects. The search query is constructed using the ResultQuery.
This session defines views that offer differing behaviors for searching.
Results may have a query record indicated by their respective record
types. The query record is accessed via the ResultQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchResults()
Tests if this user can perform
Result searches. |
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
ResultQuery |
getResultQuery()
Gets an result query.
|
ResultList |
getResultsByQuery(ResultQuery resultQuery)
Gets a list of results matching the given result query.
|
void |
useFederatedCatalogueView()
Federates the view for methods in this session.
|
void |
useIsolatedCatalogueView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCatalogueId()
Catalogue
Id
associated with
this session. Catalogue Id
associated with this sessionmandatory
- This method must be implemented. Catalogue getCatalogue() throws OperationFailedException, PermissionDeniedException
Catalogue
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchResults()
Result
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 wish not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedCatalogueView()
mandatory
- This method is must be implemented. void useIsolatedCatalogueView()
mandatory
- This method is must be implemented. ResultQuery getResultQuery()
mandatory
- This method must be implemented. ResultList getResultsByQuery(ResultQuery resultQuery) throws OperationFailedException, PermissionDeniedException
resultQuery
- the result query ResultList
NullArgumentException
- resultQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- resultQuery
is
not of this servicemandatory
- This method must be implemented.