public interface StateQuerySession extends OsidSession
This session provides methods for searching among State
objects. The search query is constructed using the StateQuery.
This session defines views that offer differing behaviors for searching.
States may have a query record indicated by their respective types.
The queryrecord is accessed via the StateQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchStates()
Tests if this user can perform
State searches. |
Process |
getProcess()
Gets the
Process associated with this session. |
Id |
getProcessId()
Gets the
Process Id associated with this
session. |
StateQuery |
getStateQuery()
Gets a state query.
|
StateList |
getStatesByQuery(StateQuery stateQuery)
Gets a list of
States matching the given state query. |
void |
useFederatedProcessView()
Federates the view for methods in this session.
|
void |
useIsolatedProcessView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getProcessId()
Process
Id
associated with this
session. Process Id
associated with this sessionmandatory
- This method must be implemented. Process getProcess() throws OperationFailedException, PermissionDeniedException
Process
associated with this session. Process
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchStates()
State
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 opt not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedProcessView()
mandatory
- This method is must be implemented. void useIsolatedProcessView()
mandatory
- This method is must be implemented. StateQuery getStateQuery()
mandatory
- This method must be implemented. StateList getStatesByQuery(StateQuery stateQuery) throws OperationFailedException, PermissionDeniedException
States
matching the given state query.stateQuery
- the state query StateList
NullArgumentException
- stateQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- stateQuery
is not
of this servicemandatory
- This method must be implemented.