public interface InstructionSmartEngineSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An InstructionQuery
can be retrieved from this
session and engineped to this Engine
to create a virtual
collection of Instructions.
The instructions may be
sequenced using the InstructionSearchOrder
from this
session.
This Engine
has a default query that matches any
instruction and a default search order that specifies no sequencing. The
queries may be examined using an InstructionQueryInspector.
The query may be modified by converting the inspector back to an
InstructionQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyInstructionQuery(InstructionQuery instructionQuery)
Applies an instruction query to this engine.
|
void |
applyInstructionSequencing(InstructionSearchOrder instructionSearchOrder)
Applies an instruction search order to this engine.
|
boolean |
canManageSmartEngines()
Tests if this user can manage smart engines.
|
Engine |
getEngine()
Gets the
Engine associated with this session. |
Id |
getEngineId()
Gets the
Engine Id associated with this
session. |
InstructionQuery |
getInstructionQuery()
Gets an instruction query.
|
InstructionQuery |
getInstructionQueryFromInspector(InstructionQueryInspector instructionQueryInspector)
Gets an instruction query from an inspector.
|
InstructionSearchOrder |
getInstructionSearchOrder()
Gets an instruction search order.
|
InstructionQueryInspector |
inspecInstructionQuery()
Gets an instruction 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. InstructionQuery getInstructionQuery()
mandatory
- This method must be implemented. InstructionSearchOrder getInstructionSearchOrder()
mandatory
- This method must be implemented. void applyInstructionQuery(InstructionQuery instructionQuery) throws OperationFailedException, PermissionDeniedException
instructionQuery
- the instruction queryNullArgumentException
- instructionQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- instructionQuery
not of this servicemandatory
- This method must be implemented. InstructionQueryInspector inspecInstructionQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyInstructionSequencing(InstructionSearchOrder instructionSearchOrder) throws OperationFailedException, PermissionDeniedException
instructionSearchOrder
- the instruction search orderNullArgumentException
- instructionSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- instructionSearchOrder
not of this servicemandatory
- This method must be implemented. InstructionQuery getInstructionQueryFromInspector(InstructionQueryInspector instructionQueryInspector)
instructionQueryInspector
- an instruction query inspectorNullArgumentException
-
instructionQueryInspector
is null
UnsupportedException
- instructionQueryInspector
is not of this servicemandatory
- This method must be implemented.