org.osid.assessment.authoring

Interface SequenceRuleSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.assessment.authoring.SequenceRuleQuerySession

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

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

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.