Interface SequenceRuleSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, SequenceRuleQuerySession

public interface SequenceRuleSearchSession
extends SequenceRuleQuerySession

This session provides methods for searching among SequenceRule objects. The search query is constructed using the SequenceRuleyQuery.

getSequenceRulesByQuery() is the basic search method and returns a list of SequenceRules. A more advanced search may be performed with getSequenceRulesBySearch().It accepts a SequenceRuleSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as workflow. getSequenceRulesBySearch() returns a SequenceRuleSearchResults that can be used to access the resulting SequenceRuleList or be used to perform a search within the result set through SequenceRuleSearch.

This session defines views that offer differing behaviors for searching.

• federated bank view: searches include sequence rule in bank of which this bank matchmaker is an ancestor in the bank hierarchy
• isolated bank view: searches are restricted to sequence rule in this bank

SequenceRules may have a query record indicated by their respective record types. The query record is accessed via the SequenceRuleQuery.

Method Summary

Modifier and Type	Method	Description
SequenceRuleQuery	getSequenceRuleQueryFromInspector(SequenceRuleQueryInspector sequenceRuleQueryInspector)	Gets a sequence rule query from an inspector.
SequenceRuleSearchResults	getSequenceRulesBySearch(SequenceRuleQuery sequenceRuleQuery, SequenceRuleSearch sequenceRuleSearch)	Gets the search results matching the given search query using the given search.
SequenceRuleSearch	getSequenceRuleSearch()	Gets a sequence rule search.
SequenceRuleSearchOrder	getSequenceRuleSearchOrder()	Gets a sequence 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 SequenceRuleQuerySession

canSearchSequenceRules, getBank, getBankId, getSequenceRuleQuery, getSequenceRulesByQuery, useFederatedBankView, useIsolatedBankView

Modifier and Type	Method	Description
boolean	canSearchSequenceRules()	Tests if this user can perform SequenceRule lookups.
Bank	getBank()	Gets the Bank associated with this session.
Id	getBankId()	Gets the Bank Id associated with this session.
SequenceRuleQuery	getSequenceRuleQuery()	Gets a sequence rule query.
SequenceRuleList	getSequenceRulesByQuery(SequenceRuleQuery sequenceRuleQuery)	Gets a list of SequenceRules matching the given sequence rule query.
void	useFederatedBankView()	Federates the view for methods in this session.
void	useIsolatedBankView()	Isolates the view for methods in this session.

Method Details

getSequenceRuleSearch

SequenceRuleSearch getSequenceRuleSearch()

Gets a sequence rule search.

Returns:

the sequence rule search

Compliance:

mandatory - This method must be implemented.

getSequenceRuleSearchOrder

SequenceRuleSearchOrder getSequenceRuleSearchOrder()

Gets a sequence rule search order. The SequenceRuleSearchOrder is supplied to a SequenceRuleSearch to specify the ordering of results.

Returns:

the sequence rule search order

Compliance:

mandatory - This method must be implemented.

getSequenceRulesBySearch

SequenceRuleSearchResults getSequenceRulesBySearch(SequenceRuleQuery sequenceRuleQuery,
 SequenceRuleSearch sequenceRuleSearch)
                                            throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

sequenceRuleQuery - the sequence rule query

sequenceRuleSearch - the sequence rule search

Returns:

the returned search results

Throws:

NullArgumentException - sequenceRuleQuery or sequenceRuleSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - sequenceRuleQuery or sequenceRuleSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getSequenceRuleQueryFromInspector

SequenceRuleQuery getSequenceRuleQueryFromInspector(SequenceRuleQueryInspector sequenceRuleQueryInspector)

Gets a sequence rule query from an inspector. The inspector is available from a SequenceRuleSearchResults.

Parameters:

sequenceRuleQueryInspector - a sequence rule query inspector

Returns:

the sequence rule query

Throws:

NullArgumentException - sequenceRuleQueryInspector is null

UnsupportedException - sequenceRuleQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.