Interface RuleSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, RuleQuerySession

public interface RuleSearchSession
extends RuleQuerySession

This session provides methods for searching Rules. 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface RuleQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchRules()	Tests if this user can perform Rule searches.
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.
RuleList	getRulesByQuery(RuleQuery ruleQuery)	Gets a list of Rules matching the given rule query.
void	useFederatedEngineView()	Federates the view for methods in this session.
void	useIsolatedEngineView()	Isolates the view for methods in this session.

Method Details

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.