org.osid.rules

Interface RuleSmartEngineSession

All Superinterfaces:

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

public interface RuleSmartEngineSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A RuleQuery can be retrieved from this session and mapped to this Engine to create a virtual collection of Rules. The rules may be sequenced using the RuleSearchOrder from this session.

This Engine has a default query that matches any rule and a default search order that specifies no sequencing. The queries may be examined using a RuleQueryInspector. The query may be modified by converting the inspector back to a RuleQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyRuleQuery(RuleQuery ruleQuery) Applies a rule query to this engine.
void	applyRuleSequencing(RuleSearchOrder ruleSearchOrder) Applies a rule search order to this engine.
boolean	canManageSmartEngines() Tests if this user can manage smart engines.
Engine	getEngine() Gets the Engine associated with this session.
Id	getEngineId() Gets the Engine Id associated with this session.
RuleQuery	getRuleQuery() Gets a rule query.
RuleQuery	getRuleQueryFromInspector(RuleQueryInspector ruleQueryInspector) Gets a rule query from an inspector.
RuleSearchOrder	getRuleSearchOrder() Gets a rule search order.
RuleQueryInspector	inspectRuleQuery() Gets a rule query inspector for this engine.

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

getEngineId

Id getEngineId()

Gets the Engine Id associated with this session.

Returns:

the Engine Id associated with this session

Compliance:

mandatory - This method must be implemented.

getEngine

Engine getEngine()
                 throws OperationFailedException,
                        PermissionDeniedException

Gets the Engine associated with this session.

Returns:

the Engine associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartEngines

boolean canManageSmartEngines()

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

Compliance:

mandatory - This method must be implemented.

getRuleQuery

RuleQuery getRuleQuery()

Gets a rule query.

Returns:

the rule query

Compliance:

mandatory - This method must be implemented.

getRuleSearchOrder

RuleSearchOrder getRuleSearchOrder()

Gets a rule search order.

Returns:

the rule search order

Compliance:

mandatory - This method must be implemented.

applyRuleQuery

void applyRuleQuery(RuleQuery ruleQuery)
                    throws OperationFailedException,
                           PermissionDeniedException

Applies a rule query to this engine.

Parameters:

ruleQuery - the rule query

Throws:

NullArgumentException - ruleQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - ruleQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectRuleQuery

RuleQueryInspector inspectRuleQuery()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets a rule query inspector for this engine.

Returns:

the rule query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyRuleSequencing

void applyRuleSequencing(RuleSearchOrder ruleSearchOrder)
                         throws OperationFailedException,
                                PermissionDeniedException

Applies a rule search order to this engine.

Parameters:

ruleSearchOrder - the rule search order

Throws:

NullArgumentException - ruleSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - ruleSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getRuleQueryFromInspector

RuleQuery getRuleQueryFromInspector(RuleQueryInspector ruleQueryInspector)

Gets a rule query from an inspector.

Parameters:

ruleQueryInspector - a rule query inspector

Returns:

the rule query

Throws:

NullArgumentException - ruleQueryInspector is null

UnsupportedException - ruleQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.