org.osid.configuration.rules

Interface ValueEnablerSmartConfigurationSession

All Superinterfaces:

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

public interface ValueEnablerSmartConfigurationSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic configurations. A ValueEnablerQuery can be retrieved from this session and mapped to this Configuration to create a virtual collection of value enablers. The value enablers may be sequenced using the ValueEnablerSearchOrder from this session.

This Configuration has a default query that matches any value enabler and a default search order that specifies no sequencing. The queries may be examined using a ValueEnablerQueryInspector. The query may be modified by converting the inspector back to a ValueEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyValueEnablerQuery(ValueEnablerQuery valueEnablerQuery) Applies a value enabler query to this configuration.
void	applyValueEnablerSequencing(ValueEnablerSearchOrder valueEnablerSearchOrder) Applies a value enabler search order to this configuration.
boolean	canManageSmartConfigurations() Tests if this user can manage smart configurations.
Configuration	getConfiguration() Gets the Configuration associated with this session.
Id	getConfigurationId() Gets the Configuration Id associated with this session.
ValueEnablerQuery	getValueEnablerQuery() Gets a value enabler query.
ValueEnablerQuery	getValueEnablerQueryFromInspector(ValueEnablerQueryInspector valueEnablerQueryInspector) Gets a value enabler query from an inspector.
ValueEnablerSearchOrder	getValueEnablerSearchOrder() Gets a value enabler search order.
ValueEnablerQueryInspector	inspectValueEnablerQuery() Gets a value enabler query inspector for this configuration.

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

getConfigurationId

Id getConfigurationId()

Gets the Configuration Id associated with this session.

Returns:

the Configuration Id associated with this session

Compliance:

mandatory - This method must be implemented.

getConfiguration

Configuration getConfiguration()
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets the Configuration associated with this session.

Returns:

the configuration

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartConfigurations

boolean canManageSmartConfigurations()

Tests if this user can manage smart configurations. 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 configuration management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getValueEnablerQuery

ValueEnablerQuery getValueEnablerQuery()

Gets a value enabler query.

Returns:

the value enabler query

Compliance:

mandatory - This method must be implemented.

getValueEnablerSearchOrder

ValueEnablerSearchOrder getValueEnablerSearchOrder()

Gets a value enabler search order.

Returns:

the value enabler search order

Compliance:

mandatory - This method must be implemented.

applyValueEnablerQuery

void applyValueEnablerQuery(ValueEnablerQuery valueEnablerQuery)
                            throws OperationFailedException,
                                   PermissionDeniedException

Applies a value enabler query to this configuration.

Parameters:

valueEnablerQuery - the value enabler query

Throws:

NullArgumentException - valueEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - valueEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectValueEnablerQuery

ValueEnablerQueryInspector inspectValueEnablerQuery()
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets a value enabler query inspector for this configuration.

Returns:

the value enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyValueEnablerSequencing

void applyValueEnablerSequencing(ValueEnablerSearchOrder valueEnablerSearchOrder)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Applies a value enabler search order to this configuration.

Parameters:

valueEnablerSearchOrder - the value enabler search order

Throws:

NullArgumentException - valueEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - valueEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getValueEnablerQueryFromInspector

ValueEnablerQuery getValueEnablerQueryFromInspector(ValueEnablerQueryInspector valueEnablerQueryInspector)

Gets a value enabler query from an inspector.

Parameters:

valueEnablerQueryInspector - a value enabler query inspector

Returns:

the value enabler query

Throws:

NullArgumentException - valueEnablerQueryInspector is null

UnsupportedException - valueEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.