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

Interface	osid.assessment.authoring.SequenceRuleEnablerSearchSession
Implements	`osid.assessment.authoring.SequenceRuleEnablerQuerySession`
Used By	`osid.assessment.authoring.AssessmentAuthoringManager`
Used By	`osid.assessment.authoring.AssessmentAuthoringProxyManager`
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` .
Method	getSequenceRuleEnablerSearch
Description	Gets a sequence rule enabler search.
Return	`osid.assessment.authoring.SequenceRuleEnablerSearch`		the sequence rule enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getSequenceRuleEnablerSearchOrder
Description	Gets a sequence rule enabler search order. The `SequenceRuleEnablerSearchOrder` is supplied to a `SequenceRuleEnablerSearch` to specify the ordering of results.
Return	`osid.assessment.authoring.SequenceRuleEnablerSearchOrder`		the sequence rule enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getSequenceRuleEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.assessment.authoring.SequenceRuleEnablerQuery`	`sequenceRuleEnablerQuery`	the sequence rule enabler query
Parameters	`osid.assessment.authoring.SequenceRuleEnablerSearch`	`sequenceRuleEnablerSearch`	the sequence rule enabler search
Return	`osid.assessment.authoring.SequenceRuleEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`sequenceRuleEnablerQuery` or `sequenceRuleEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`sequenceRuleEnablerQuery` or `sequenceRuleEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSequenceRuleEnablerQueryFromInspector
Description	Gets a sequence rule enabler query from an inspector. The inspector is available from a `SequenceRuleEnablerSearchResults` .
Parameters	`osid.assessment.authoring.SequenceRuleEnablerQueryInspector`	`sequenceRuleEnablerQueryInspector`	a sequence rule enabler query inspector
Return	`osid.assessment.authoring.SequenceRuleEnablerQuery`		the sequence rule enabler query
Errors	NULL_ARGUMENT		`sequenceRuleEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`sequenceRuleEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.