public interface ActionEnablerSmartSystemSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
systems. An ActionEnablerQuery
can be retrieved from this
session and mapped to this System
to create a virtual
collection of action enablers. The action enablers may be sequenced using
the ActionEnablerSearchOrder
from this session.
This System
has a default query that matches any action
enabler and a default search order that specifies no sequencing. The
queries may be examined using an ActionEnablerQueryInspector.
The query may be modified by converting the inspector back to an
ActionEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyActionEnablerQuery(ActionEnablerQuery actionEnablerQuery)
Applies an action enabler query to this system.
|
void |
applyActionEnablerSequencing(ActionEnablerSearchOrder actionEnablerSearchOrder)
Applies an action enabler search order to this system.
|
boolean |
canManageSmartSystems()
Tests if this user can manage smart systems.
|
ActionEnablerQuery |
getActionEnablerQuery()
Gets an action enabler query.
|
ActionEnablerQuery |
getActionEnablerQueryFromInspector(ActionEnablerQueryInspector actionEnablerQueryInspector)
Gets an action enabler query from an inspector.
|
ActionEnablerSearchOrder |
getActionEnablerSearchOrder()
Gets an action enabler search order.
|
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
ActionEnablerQueryInspector |
inspectActionEnablerQuery()
Gets an action 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. ActionEnablerQuery getActionEnablerQuery()
mandatory
- This method must be implemented. ActionEnablerSearchOrder getActionEnablerSearchOrder()
mandatory
- This method must be implemented. void applyActionEnablerQuery(ActionEnablerQuery actionEnablerQuery) throws OperationFailedException, PermissionDeniedException
actionEnablerQuery
- the action enabler queryNullArgumentException
- actionEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- actionEnablerQuery
not of this servicemandatory
- This method must be implemented. ActionEnablerQueryInspector inspectActionEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyActionEnablerSequencing(ActionEnablerSearchOrder actionEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
actionEnablerSearchOrder
- the action enabler search orderNullArgumentException
- actionEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- actionEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. ActionEnablerQuery getActionEnablerQueryFromInspector(ActionEnablerQueryInspector actionEnablerQueryInspector)
actionEnablerQueryInspector
- an action enabler query inspectorNullArgumentException
-
actionEnablerQueryInspector
is null
UnsupportedException
-
actionEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.