public interface TriggerEnablerSmartSystemSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
systems. A TriggerEnablerQuery
can be retrieved from this
session and mapped to this System
to create a virtual
collection of trigger enablers. The trigger enablers may be sequenced
using the TriggerEnablerSearchOrder
from this session.
This System
has a default query that matches any
trigger enabler and a default search order that specifies no sequencing.
The queries may be examined using a TriggerEnablerQueryInspector.
The query may be modified by converting the inspector back to a
TriggerEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyTriggerEnablerQuery(TriggerEnablerQuery triggerEnablerQuery)
Applies a trigger enabler query to this system.
|
void |
applyTriggerEnablerSequencing(TriggerEnablerSearchOrder triggerEnablerSearchOrder)
Applies a trigger enabler search order to this system.
|
boolean |
canManageSmartSystems()
Tests if this user can manage smart systems.
|
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
TriggerEnablerQuery |
getTriggerEnablerQuery()
Gets a trigger enabler query.
|
TriggerEnablerQuery |
getTriggerEnablerQueryFromInspector(TriggerEnablerQueryInspector triggerEnablerQueryInspector)
Gets a trigger enabler query from an inspector.
|
TriggerEnablerSearchOrder |
getTriggerEnablerSearchOrder()
Gets a trigger enabler search order.
|
TriggerEnablerQueryInspector |
inspectTriggerEnablerQuery()
Gets a trigger 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. TriggerEnablerQuery getTriggerEnablerQuery()
mandatory
- This method must be implemented. TriggerEnablerSearchOrder getTriggerEnablerSearchOrder()
mandatory
- This method must be implemented. void applyTriggerEnablerQuery(TriggerEnablerQuery triggerEnablerQuery) throws OperationFailedException, PermissionDeniedException
triggerEnablerQuery
- the trigger enabler queryNullArgumentException
- triggerEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- triggerEnablerQuery
not of this servicemandatory
- This method must be implemented. TriggerEnablerQueryInspector inspectTriggerEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyTriggerEnablerSequencing(TriggerEnablerSearchOrder triggerEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
triggerEnablerSearchOrder
- the trigger enabler search orderNullArgumentException
-
triggerEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- triggerEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. TriggerEnablerQuery getTriggerEnablerQueryFromInspector(TriggerEnablerQueryInspector triggerEnablerQueryInspector)
triggerEnablerQueryInspector
- a trigger enabler query inspectorNullArgumentException
-
triggerEnablerQueryInspector
is null
UnsupportedException
-
triggerEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.