OSID Logo
OSID Specifications
assessment authoring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.authoring.SequenceRuleSearchSession
Implementsosid.assessment.authoring.SequenceRuleQuerySession
Description

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.

MethodgetSequenceRuleSearch
Description

Gets a sequence rule search.

Returnosid.assessment.authoring.SequenceRuleSearchthe sequence rule search
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleSearchOrder
Description

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

Returnosid.assessment.authoring.SequenceRuleSearchOrderthe sequence rule search order
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRulesBySearch
Description

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

Parametersosid.assessment.authoring.SequenceRuleQuerysequenceRuleQuerythe sequence rule query
osid.assessment.authoring.SequenceRuleSearchsequenceRuleSearchthe sequence rule search
Returnosid.assessment.authoring.SequenceRuleSearchResultsthe returned search results
ErrorsNULL_ARGUMENT sequenceRuleQuery or sequenceRuleSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED sequenceRuleQuery or sequenceRuleSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleQueryFromInspector
Description

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

Parametersosid.assessment.authoring.SequenceRuleQueryInspectorsequenceRuleQueryInspectora sequence rule query inspector
Returnosid.assessment.authoring.SequenceRuleQuerythe sequence rule query
ErrorsNULL_ARGUMENT sequenceRuleQueryInspector is null
UNSUPPORTED sequenceRuleQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.