org.osid.control

Interface SettingSmartSystemSession

All Superinterfaces:

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

public interface SettingSmartSystemSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A SettingQuery can be retrieved from this session and systemped to this System to create a virtual collection of Settings. The settings may be sequenced using the SettingSearchOrder from this session.

This System has a default query that matches any setting and a default search order that specifies no sequencing. The queries may be examined using a SettingQueryInspector. The query may be modified by converting the inspector back to a SettingQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applySettingQuery(SettingQuery settingQuery) Applies a setting query to this system.
void	applySettingSequencing(SettingSearchOrder settingSearchOrder) Applies a setting search order to this system.
boolean	canManageSmartSystems() Tests if this user can manage smart systems.
SettingQuery	getSettingQuery() Gets a setting query.
SettingQuery	getSettingQueryFromInspector(SettingQueryInspector settingQueryInspector) Gets a setting query from an inspector.
SettingSearchOrder	getSettingSearchOrder() Gets a setting search order.
System	getSystem() Gets the System associated with this session.
Id	getSystemId() Gets the System Id associated with this session.
SettingQueryInspector	inspectSettingQuery() Gets a setting 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.

getSettingQuery

SettingQuery getSettingQuery()

Gets a setting query.

Returns:

the setting query

Compliance:

mandatory - This method must be implemented.

getSettingSearchOrder

SettingSearchOrder getSettingSearchOrder()

Gets a setting search order.

Returns:

the setting search order

Compliance:

mandatory - This method must be implemented.

applySettingQuery

void applySettingQuery(SettingQuery settingQuery)
                       throws OperationFailedException,
                              PermissionDeniedException

Applies a setting query to this system.

Parameters:

settingQuery - the setting query

Throws:

NullArgumentException - settingQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - settingQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectSettingQuery

SettingQueryInspector inspectSettingQuery()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets a setting query inspector for this system.

Returns:

the setting query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applySettingSequencing

void applySettingSequencing(SettingSearchOrder settingSearchOrder)
                            throws OperationFailedException,
                                   PermissionDeniedException

Applies a setting search order to this system.

Parameters:

settingSearchOrder - the setting search order

Throws:

NullArgumentException - settingSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - settingSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getSettingQueryFromInspector

SettingQuery getSettingQueryFromInspector(SettingQueryInspector settingQueryInspector)

Gets a setting query from an inspector.

Parameters:

settingQueryInspector - a setting query inspector

Returns:

the setting query

Throws:

NullArgumentException - settingQueryInspector is null

UnsupportedException - settingQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.