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

Interface	osid.hold.rules.IssueProcessorSearchSession
Implements	`osid.hold.rules.IssueProcessorQuerySession`
Used By	`osid.hold.rules.HoldRulesManager`
Used By	`osid.hold.rules.HoldRulesProxyManager`
Description	This session provides methods for searching among `IssueProcessors` . The search query is constructed using the `IssueProcessorQuery` . `getIssueProcessorsByQuery()` is the basic search method and returns a list of `IssueProcessors` . A more advanced search may be performed with `getIssueProcessorsBySearch()` . It accepts an `IssueProcessorSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getIssueProcessorsBySearch()` returns an `IssueProcessorSearchResults` that can be used to access the resulting `IssueProcessorList` or be used to perform a search within the result set through `IssueProcessorSearch` . `This session defines views that offer differing behaviors for searching` . federated oubliette view: searches include issue processors in oubliettes of which this oubliette is an ancestor in the oubliette hierarchy isolated oubliette view: searches are restricted to issue processors in this oubliette Issue processors may have a query record indicated by their respective record types. The query record is accessed via the `IssueProcessorQuery` .
Method	getIssueProcessorSearch
Description	Gets an issue processor search.
Return	`osid.hold.rules.IssueProcessorSearch`		the issue processor search
Compliance	`mandatory`		This method must be implemented.
Method	getIssueProcessorSearchOrder
Description	Gets an issue processor search order. The `IssueProcessorSearchOrder` is supplied to an `IssueProcessorSearch` to specify the ordering of results.
Return	`osid.hold.rules.IssueProcessorSearchOrder`		the issue processor search order
Compliance	`mandatory`		This method must be implemented.
Method	getIssueProcessorBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.hold.rules.IssueProcessorQuery`	`issueProcessorQuery`	the issue processor query
Parameters	`osid.hold.rules.IssueProcessorSearch`	`issueProcessorSearch`	the issue processor search
Return	`osid.hold.rules.IssueProcessorSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`issueProcessorQuery` or `issueProcessorSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`issueProcessorQuery` or `issueProcessorSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getIssueProcessorQueryFromInspector
Description	Gets an issue processor query from an inspector. The inspector is available from an `IssueProcessorSearchResults` .
Parameters	`osid.hold.rules.IssueProcessorQueryInspector`	`issueProcessorQueryInspector`	an issue processor query inspector
Return	`osid.hold.rules.IssueProcessorQuery`		the issue processor query
Errors	NULL_ARGUMENT		`issueProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`issueProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.