public interface AgendaQuerySession extends OsidSession
This session provides methods for searching among Agenda
objects. The search query is constructed using the AgendaQuery.
This session defines views that offer differing behaviors for searching.
Agendas may have a query record indicated by their respective record
types. The query record is accessed via the AgendaQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchAgendas()
Tests if this user can perform
Agenda lookups. |
AgendaQuery |
getAgendaQuery()
Gets an agenda query.
|
AgendaList |
getAgendasByQuery(AgendaQuery agendaQuery)
Gets a list of
Agendas matching the given agenda 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 canSearchAgendas()
Agenda
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. AgendaQuery getAgendaQuery()
mandatory
- This method must be implemented. AgendaList getAgendasByQuery(AgendaQuery agendaQuery) throws OperationFailedException, PermissionDeniedException
Agendas
matching the given agenda query.agendaQuery
- the agenda query AgendaList
NullArgumentException
- agendaQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- agendaQuery
is
not of this servicemandatory
- This method must be implemented.