public interface ControllerSmartSystemSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A ControllerQuery
can be retrieved from this
session and mapped to this System
to create a virtual
collection of controllers. The controllers may be sequenced using the
ControllerSearchOrder
from this session.
This System
has a default query that matches any
controller and a default search order that specifies no sequencing. The
queries may be examined using a ControllerQueryInspector.
The query may be modified by converting the inspector back to a
ControllerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyControllerQuery(ControllerQuery controllerQuery)
Applies a controller query to this system.
|
void |
applyControllerSequencing(ControllerSearchOrder controllerSearchOrder)
Applies a controller search order to this system.
|
boolean |
canManageSmartSystems()
Tests if this user can manage smart systems.
|
ControllerQuery |
getControllerQuery()
Gets a controller query.
|
ControllerQuery |
getControllerQueryFromInspector(ControllerQueryInspector controllerQueryInspector)
Gets a controller query from an inspector.
|
ControllerSearchOrder |
getControllerSearchOrder()
Gets a controller search order.
|
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
ControllerQueryInspector |
inspecControllerQuery()
Gets a controller 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. ControllerQuery getControllerQuery()
mandatory
- This method must be implemented. ControllerSearchOrder getControllerSearchOrder()
mandatory
- This method must be implemented. void applyControllerQuery(ControllerQuery controllerQuery) throws OperationFailedException, PermissionDeniedException
controllerQuery
- the controller queryNullArgumentException
- controllerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- controllerQuery
not of this servicemandatory
- This method must be implemented. ControllerQueryInspector inspecControllerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyControllerSequencing(ControllerSearchOrder controllerSearchOrder) throws OperationFailedException, PermissionDeniedException
controllerSearchOrder
- the controller search orderNullArgumentException
- controllerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- controllerSearchOrder
not of this servicemandatory
- This method must be implemented. ControllerQuery getControllerQueryFromInspector(ControllerQueryInspector controllerQueryInspector)
controllerQueryInspector
- a controller query inspectorNullArgumentException
- controllerQueryInspector
is null
UnsupportedException
- controllerQueryInspector
is not of this servicemandatory
- This method must be implemented.