org.osid.configuration.rules

Interface ParameterProcessorEnablerSmartConfigurationSession

All Superinterfaces:

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

public interface ParameterProcessorEnablerSmartConfigurationSession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyParameterProcessorEnablerQuery(ParameterProcessorEnablerQuery parameterProcessorEnablerQuery) Applies a parameter processor enabler query to this configuration.
void	applyParameterProcessorEnablerSequencing(ParameterProcessorEnablerSearchOrder parameterProcessorEnablerSearchOrder) Applies a parameter processor 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.
ParameterProcessorEnablerQuery	getParameterProcessorEnablerQuery() Gets a parameter processor enabler query.
ParameterProcessorEnablerQuery	getParameterProcessorEnablerQueryFromInspector(ParameterProcessorEnablerQueryInspector parameterProcessorEnablerQueryInspector) Gets a parameter processor enabler query from an inspector.
ParameterProcessorEnablerSearchOrder	getParameterProcessorEnablerSearchOrder() Gets a parameter processor enabler search order.
ParameterProcessorEnablerQueryInspector	inspectParameterProcessorEnablerQuery() Gets a parameter processor 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.

getParameterProcessorEnablerQuery

ParameterProcessorEnablerQuery getParameterProcessorEnablerQuery()

Gets a parameter processor enabler query.

Returns:

the parameter processor enabler query

Compliance:

mandatory - This method must be implemented.

getParameterProcessorEnablerSearchOrder

ParameterProcessorEnablerSearchOrder getParameterProcessorEnablerSearchOrder()

Gets a parameter processor enabler search order.

Returns:

the parameter processor enabler search order

Compliance:

mandatory - This method must be implemented.

applyParameterProcessorEnablerQuery

void applyParameterProcessorEnablerQuery(ParameterProcessorEnablerQuery parameterProcessorEnablerQuery)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Applies a parameter processor enabler query to this configuration.

Parameters:

parameterProcessorEnablerQuery - the parameter processor enabler query

Throws:

NullArgumentException - parameterProcessorEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - parameterProcessorEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectParameterProcessorEnablerQuery

ParameterProcessorEnablerQueryInspector inspectParameterProcessorEnablerQuery()
                                                                              throws OperationFailedException,
                                                                                     PermissionDeniedException

Gets a parameter processor enabler query inspector for this configuration.

Returns:

the parameter processor enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyParameterProcessorEnablerSequencing

void applyParameterProcessorEnablerSequencing(ParameterProcessorEnablerSearchOrder parameterProcessorEnablerSearchOrder)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Applies a parameter processor enabler search order to this configuration.

Parameters:

parameterProcessorEnablerSearchOrder - the parameter processor enabler search order

Throws:

NullArgumentException - parameterProcessorEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - parameterProcessorEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getParameterProcessorEnablerQueryFromInspector

ParameterProcessorEnablerQuery getParameterProcessorEnablerQueryFromInspector(ParameterProcessorEnablerQueryInspector parameterProcessorEnablerQueryInspector)

Gets a parameter processor enabler query from an inspector.

Parameters:

parameterProcessorEnablerQueryInspector - a parameter processor enabler query inspector

Returns:

the parameter processor enabler query

Throws:

NullArgumentException - parameterProcessorEnablerQueryInspector is null

UnsupportedException - parameterProcessorEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.