public interface InputEnablerSmartSystemSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
systems. An InputEnablerQuery
can be retrieved from this
session and mapped to this System
to create a virtual
collection of input enablers. The input enablers may be sequenced using
the InputEnablerSearchOrder
from this session.
This System
has a default query that matches any input
enabler and a default search order that specifies no sequencing. The
queries may be examined using an InputEnablerQueryInspector.
The query may be modified by converting the inspector back to an
InputEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyInputEnablerQuery(InputEnablerQuery inputEnablerQuery)
Applies an input enabler query to this system.
|
void |
applyInputEnablerSequencing(InputEnablerSearchOrder inputEnablerSearchOrder)
Applies an input enabler search order to this system.
|
boolean |
canManageSmartSystems()
Tests if this user can manage smart systems.
|
InputEnablerQuery |
getInputEnablerQuery()
Gets an input enabler query.
|
InputEnablerQuery |
getInputEnablerQueryFromInspector(InputEnablerQueryInspector inputEnablerQueryInspector)
Gets an input enabler query from an inspector.
|
InputEnablerSearchOrder |
getInputEnablerSearchOrder()
Gets an input enabler search order.
|
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
InputEnablerQueryInspector |
inspectInputEnablerQuery()
Gets an input enabler query inspector for this system.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getSystemId()
System
Id
associated with this
session. System Id
associated with this sessionmandatory
- This method must be implemented. System getSystem() throws OperationFailedException, PermissionDeniedException
System
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartSystems()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart system management is not
authorized, true
otherwisemandatory
- This method must be implemented. InputEnablerQuery getInputEnablerQuery()
mandatory
- This method must be implemented. InputEnablerSearchOrder getInputEnablerSearchOrder()
mandatory
- This method must be implemented. void applyInputEnablerQuery(InputEnablerQuery inputEnablerQuery) throws OperationFailedException, PermissionDeniedException
inputEnablerQuery
- the input enabler queryNullArgumentException
- inputEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- inputEnablerQuery
not of this servicemandatory
- This method must be implemented. InputEnablerQueryInspector inspectInputEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyInputEnablerSequencing(InputEnablerSearchOrder inputEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
inputEnablerSearchOrder
- the input enabler search orderNullArgumentException
- inputEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- inputEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. InputEnablerQuery getInputEnablerQueryFromInspector(InputEnablerQueryInspector inputEnablerQueryInspector)
inputEnablerQueryInspector
- an input enabler query inspectorNullArgumentException
-
inputEnablerQueryInspector
is null
UnsupportedException
-
inputEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.