public interface AgendaSmartEngineSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An AgendaQuery
can be retrieved from this session
and mapped to this Engine
to create a virtual collection of
Agendas.
The agendas may be sequenced using the
AgendaSearchOrder
from this session.
This Engine
has a default query that matches any agenda
and a default search order that specifies no sequencing. The queries may
be examined using an AgendaQueryInspector.
The query may be
modified by converting the inspector back to an AgendaQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyAgendaQuery(AgendaQuery agendaQuery)
Applies an agenda query to this engine.
|
void |
applyAgendaSequencing(AgendaSearchOrder agendaSearchOrder)
Applies an agenda search order to this engine.
|
boolean |
canManageSmartEngines()
Tests if this user can manage smart engines.
|
AgendaQuery |
getAgendaQuery()
Gets an agenda query.
|
AgendaQuery |
getAgendaQueryFromInspector(AgendaQueryInspector agendaQueryInspector)
Gets an agenda query from an inspector.
|
AgendaSearchOrder |
getAgendaSearchOrder()
Gets an agenda search order.
|
Engine |
getEngine()
Gets the
Engine associated with this session. |
Id |
getEngineId()
Gets the
Engine Id associated with this
session. |
AgendaQueryInspector |
inspectAgendaQuery()
Gets an agenda query inspector for this engine.
|
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 canManageSmartEngines()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart engine management is not
authorized, true
otherwisemandatory
- This method must be implemented. AgendaQuery getAgendaQuery()
mandatory
- This method must be implemented. AgendaSearchOrder getAgendaSearchOrder()
mandatory
- This method must be implemented. void applyAgendaQuery(AgendaQuery agendaQuery) throws OperationFailedException, PermissionDeniedException
agendaQuery
- the agenda queryNullArgumentException
- agendaQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- agendaQuery
not
of this servicemandatory
- This method must be implemented. AgendaQueryInspector inspectAgendaQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyAgendaSequencing(AgendaSearchOrder agendaSearchOrder) throws OperationFailedException, PermissionDeniedException
agendaSearchOrder
- the agenda search orderNullArgumentException
- agendaSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- agendaSearchOrder
not of this servicemandatory
- This method must be implemented. AgendaQuery getAgendaQueryFromInspector(AgendaQueryInspector agendaQueryInspector)
agendaQueryInspector
- an agenda query inspectorNullArgumentException
- agendaQueryInspector
is null
UnsupportedException
- agendaQueryInspector
is not of this servicemandatory
- This method must be implemented.