public interface CheckQuerySession extends OsidSession
This session provides methods for searching among Check
objects. The search query is constructed using the CheckQuery.
This session defines views that offer differing behaviors for searching.
Checks may have a query record indicated by their respective record
types. The query record is accessed via the CheckQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchChecks()
Tests if this user can perform
Check lookups. |
CheckQuery |
getCheckQuery()
Gets a check query.
|
CheckList |
getChecksByQuery(CheckQuery checkQuery)
Gets a list of
Checks matching the given check query. |
Engine |
getEngine()
Gets the
Engine associated with this session. |
Id |
getEngineId()
Gets the
Engine Id associated with this
session. |
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 canSearchChecks()
Check
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 useFederatedEngineView()
mandatory
- This method is must be implemented. void useIsolatedEngineView()
mandatory
- This method is must be implemented. CheckQuery getCheckQuery()
mandatory
- This method must be implemented. CheckList getChecksByQuery(CheckQuery checkQuery) throws OperationFailedException, PermissionDeniedException
Checks
matching the given check query.checkQuery
- the check query CheckList
NullArgumentException
- checkQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- checkQuery
is not
of this servicemandatory
- This method must be implemented.