org.osid.configuration

Interface ParameterSmartConfigurationSession

All Superinterfaces:

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

public interface ParameterSmartConfigurationSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A ParameterQuery can be retrieved from this session and mapped to this Configuration to create a virtual collection of Parameters. The parameters may be sequenced using the ParameterSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyParameterQuery(ParameterQuery parameterQuery) Applies a parameter query to this configuration.
void	applyParameterSequencing(ParameterSearchOrder parameterSearchOrder) Applies a parameter 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.
ParameterQuery	getParameterQuery() Gets a parameter query.
ParameterQuery	getParameterQueryFromInspector(ParameterQueryInspector parameterQueryInspector) Gets a parameter query from an inspector.
ParameterSearchOrder	getParameterSearchOrder() Gets a parameter search order.
ParameterQueryInspector	inspecParameterQuery() Gets a parameter 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 associated with this session

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 cobfiguration management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getParameterQuery

ParameterQuery getParameterQuery()

Gets a parameter query.

Returns:

the parameter query

Compliance:

mandatory - This method must be implemented.

getParameterSearchOrder

ParameterSearchOrder getParameterSearchOrder()

Gets a parameter search order.

Returns:

the parameter search order

Compliance:

mandatory - This method must be implemented.

applyParameterQuery

void applyParameterQuery(ParameterQuery parameterQuery)
                         throws OperationFailedException,
                                PermissionDeniedException

Applies a parameter query to this configuration.

Parameters:

parameterQuery - the parameter query

Throws:

NullArgumentException - parameterQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - parameterQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspecParameterQuery

ParameterQueryInspector inspecParameterQuery()
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Gets a parameter query inspector for this configuration.

Returns:

the parameter query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyParameterSequencing

void applyParameterSequencing(ParameterSearchOrder parameterSearchOrder)
                              throws OperationFailedException,
                                     PermissionDeniedException

Applies a parameter search order to this configuration.

Parameters:

parameterSearchOrder - the parameter search order

Throws:

NullArgumentException - parameterSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - parameterSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getParameterQueryFromInspector

ParameterQuery getParameterQueryFromInspector(ParameterQueryInspector parameterQueryInspector)

Gets a parameter query from an inspector.

Parameters:

parameterQueryInspector - a parameter query inspector

Returns:

the parameter query

Throws:

NullArgumentException - parameterQueryInspector is null

UnsupportedException - parameterQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.