org.osid.rules

Interface RuleSearchSession

All Superinterfaces:

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

public interface RuleSearchSession
extends RuleQuerySession

This session provides methods for searching Rule objects. The search query is constructed using the RuleQuery. The rule record Type also specifies the record for the rule query.

getRulesByQuery() is the basic search method and returns a list of Rule elements. A more advanced search may be performed with getRulesBySearch(). It accepts a RuleSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRulesBySearch() returns a RuleSearchResults that can be used to access the resulting RuleList or be used to perform a search within the result set through RuleSearch.

Rules may have a query record indicated by their respective record types. The rule query record is accessed via the RuleQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Methods

Modifier and Type	Method and Description
RuleQuery	getRuleQueryFromInspector(RuleQueryInspector ruleQueryInspector) Gets a rule query from an inspector.
RuleSearchResults	getRulesBySearch(RuleQuery ruleQuery, RuleSearch ruleSearch) Gets the search results matching the given search.
RuleSearch	getRuleSearch() Gets a rule search.
RuleSearchOrder	getRuleSearchOrder() Gets a rule search order.

Methods inherited from interface org.osid.rules.RuleQuerySession

canSearchRules, getEngine, getEngineId, getRuleQuery, getRulesByQuery, useFederatedEngineView, useIsolatedEngineView

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

getRuleSearch

RuleSearch getRuleSearch()

Gets a rule search.

Returns:

the rule search

Compliance:

mandatory - This method must be implemented.

getRuleSearchOrder

RuleSearchOrder getRuleSearchOrder()

Gets a rule search order. The RuleSearchOrder is supplied to a RuleSearch to specify the ordering of results.

Returns:

the rule search order

Compliance:

mandatory - This method must be implemented.

getRulesBySearch

RuleSearchResults getRulesBySearch(RuleQuery ruleQuery,
                                 RuleSearch ruleSearch)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets the search results matching the given search.

Parameters:

ruleQuery - the rule query

ruleSearch - the rule search

Returns:

the search results

Throws:

NullArgumentException - ruleQuery or ruleSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - ruleQuery or ruleSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getRuleQueryFromInspector

RuleQuery getRuleQueryFromInspector(RuleQueryInspector ruleQueryInspector)

Gets a rule query from an inspector. The inspector is available from a RuleSearchResults.

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.