OSID - osid.assessment.authoring.SequenceRuleSearchSession Service Interface Definition

Interface	osid.assessment.authoring.SequenceRuleSearchSession
Implements	`osid.assessment.authoring.SequenceRuleQuerySession`
Used By	`osid.assessment.authoring.AssessmentAuthoringManager`
Used By	`osid.assessment.authoring.AssessmentAuthoringProxyManager`
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` .
Method	getSequenceRuleSearch
Description	Gets a sequence rule search.
Return	`osid.assessment.authoring.SequenceRuleSearch`		the sequence rule search
Compliance	`mandatory`		This method must be implemented.
Method	getSequenceRuleSearchOrder
Description	Gets a sequence rule search order. The `SequenceRuleSearchOrder` is supplied to a `SequenceRuleSearch` to specify the ordering of results.
Return	`osid.assessment.authoring.SequenceRuleSearchOrder`		the sequence rule search order
Compliance	`mandatory`		This method must be implemented.
Method	getSequenceRulesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.assessment.authoring.SequenceRuleQuery`	`sequenceRuleQuery`	the sequence rule query
Parameters	`osid.assessment.authoring.SequenceRuleSearch`	`sequenceRuleSearch`	the sequence rule search
Return	`osid.assessment.authoring.SequenceRuleSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`sequenceRuleQuery` or `sequenceRuleSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`sequenceRuleQuery` or `sequenceRuleSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSequenceRuleQueryFromInspector
Description	Gets a sequence rule query from an inspector. The inspector is available from a `SequenceRuleSearchResults` .
Parameters	`osid.assessment.authoring.SequenceRuleQueryInspector`	`sequenceRuleQueryInspector`	a sequence rule query inspector
Return	`osid.assessment.authoring.SequenceRuleQuery`		the sequence rule query
Errors	NULL_ARGUMENT		`sequenceRuleQueryInspector` is `null`
Errors	UNSUPPORTED		`sequenceRuleQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.