OSID - osid.hold.rules.IssueProcessorEnablerSearchSession Service Interface Definition

Interface	osid.hold.rules.IssueProcessorEnablerSearchSession
Implements	`osid.hold.rules.IssueProcessorEnablerQuerySession`
Used By	`osid.hold.rules.HoldRulesManager`
Used By	`osid.hold.rules.HoldRulesProxyManager`
Description	This session provides methods for searching among `IssueProcessorEnablers` . The search query is constructed using the `IssueProcessorEnablerQuery` . `getIssueProcessorEnablersByQuery()` is the basic search method and returns a list of `IssueProcessorEnablers` . A more advanced search may be performed with `getIssueProcessorEnablersBySearch()` .It accepts an `IssueProcessorEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getIssueProcessorEnablersBySearch()` returns an `IssueProcessorEnablerSearchResults` that can be used to access the resulting `IssueProcessorEnablerList` or be used to perform a search within the result set through Is `sueProcessorEnablerSearch` . This session defines views that offer differing behaviors for searching. federated oubliette view: searches include issue processor enablers in oubliettes of which this oubliette is an ancestor in the oubliette hierarchy isolated oubliette view: searches are restricted to issue processor enablers in this oubliette Issue processor enablers may have a query record indicated by their respective record types. The query record is accessed via the `IssueProcessorEnablerQuery` .
Method	getIssueProcessorEnablerSearch
Description	Gets an issue processor enabler search.
Return	`osid.hold.rules.IssueProcessorEnablerSearch`		the issue processor enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getIssueProcessorEnablerSearchOrder
Description	Gets an issue processor enabler search order. The `IssueProcessorEnablerSearchOrder` is supplied to an `IssueProcessorEnablerSearch` to specify the ordering of results.
Return	`osid.hold.rules.IssueProcessorEnablerSearchOrder`		the issue processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getIssueProcessorEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.hold.rules.IssueProcessorEnablerQuery`	`issueProcessorEnablerQuery`	the issue processor enabler query
Parameters	`osid.hold.rules.IssueProcessorEnablerSearch`	`issueProcessorEnablerSearch`	the issue processor enabler search
Return	`osid.hold.rules.IssueProcessorEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`issueProcessorEnablerQuery` or `issueProcessorEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`issueProcessorEnablerQuery` or `issueProcessorEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getIssueProcessorEnablerQueryFromInspector
Description	Gets an issue processor enabler query from an inspector. The inspector is available from an `IssueProcessorEnablerSearchResults` .
Parameters	`osid.hold.rules.IssueProcessorEnablerQueryInspector`	`issueProcessorEnablerQueryInspector`	an issue processor enabler query inspector
Return	`osid.hold.rules.IssueProcessorEnablerQuery`		the issue processor enabler query
Errors	NULL_ARGUMENT		`issueProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`issueProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.