org.osid.control.rules

Interface ActionEnablerSmartSystemSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getSystemId

Id getSystemId()

Gets the System Id associated with this session.

Returns:

the System Id associated with this session

Compliance:

mandatory - This method must be implemented.

getSystem

System getSystem()
                 throws OperationFailedException,
                        PermissionDeniedException

Gets the System associated with this session.

Returns:

the system

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartSystems

boolean canManageSmartSystems()

Tests if this user can manage smart systems. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returns:

false if smart system management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getActionEnablerQuery

ActionEnablerQuery getActionEnablerQuery()

Gets an action enabler query.

Returns:

the action enabler query

Compliance:

mandatory - This method must be implemented.

getActionEnablerSearchOrder

ActionEnablerSearchOrder getActionEnablerSearchOrder()

Gets an action enabler search order.

Returns:

the action enabler search order

Compliance:

mandatory - This method must be implemented.

applyActionEnablerQuery

void applyActionEnablerQuery(ActionEnablerQuery actionEnablerQuery)
                             throws OperationFailedException,
                                    PermissionDeniedException

Applies an action enabler query to this system.

Parameters:

actionEnablerQuery - the action enabler query

Throws:

NullArgumentException - actionEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - actionEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectActionEnablerQuery

ActionEnablerQueryInspector inspectActionEnablerQuery()
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets an action enabler query inspector for this system.

Returns:

the action enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyActionEnablerSequencing

void applyActionEnablerSequencing(ActionEnablerSearchOrder actionEnablerSearchOrder)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Applies an action enabler search order to this system.

Parameters:

actionEnablerSearchOrder - the action enabler search order

Throws:

NullArgumentException - actionEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - actionEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getActionEnablerQueryFromInspector

ActionEnablerQuery getActionEnablerQueryFromInspector(ActionEnablerQueryInspector actionEnablerQueryInspector)

Gets an action enabler query from an inspector.

Parameters:

actionEnablerQueryInspector - an action enabler query inspector

Returns:

the action enabler query

Throws:

NullArgumentException - actionEnablerQueryInspector is null

UnsupportedException - actionEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.