OSID Logo
OSID Specifications
assessment authoring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.authoring.SequenceRuleEnablerSearchSession
Implementsosid.assessment.authoring.SequenceRuleEnablerQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetSequenceRuleEnablerSearch
Description

Gets a sequence rule enabler search.

Returnosid.assessment.authoring.SequenceRuleEnablerSearchthe sequence rule enabler search
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleEnablerSearchOrder
Description

Gets a sequence rule enabler search order. The SequenceRuleEnablerSearchOrder is supplied to a SequenceRuleEnablerSearch to specify the ordering of results.

Returnosid.assessment.authoring.SequenceRuleEnablerSearchOrderthe sequence rule enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleEnablersBySearch
Description

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

Parametersosid.assessment.authoring.SequenceRuleEnablerQuerysequenceRuleEnablerQuerythe sequence rule enabler query
osid.assessment.authoring.SequenceRuleEnablerSearchsequenceRuleEnablerSearchthe sequence rule enabler search
Returnosid.assessment.authoring.SequenceRuleEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT sequenceRuleEnablerQuery or sequenceRuleEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED sequenceRuleEnablerQuery or sequenceRuleEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSequenceRuleEnablerQueryFromInspector
Description

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

Parametersosid.assessment.authoring.SequenceRuleEnablerQueryInspectorsequenceRuleEnablerQueryInspectora sequence rule enabler query inspector
Returnosid.assessment.authoring.SequenceRuleEnablerQuerythe sequence rule enabler query
ErrorsNULL_ARGUMENT sequenceRuleEnablerQueryInspector is null
UNSUPPORTED sequenceRuleEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.