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

Interface	osid.hold.rules.IssueEnablerSearchSession
Implements	`osid.hold.rules.IssueEnablerQuerySession`
Used By	`osid.hold.rules.HoldRulesManager`
Used By	`osid.hold.rules.HoldRulesProxyManager`
Description	This session provides methods for searching among `IssueEnablers` . The search query is constructed using the `IssueEnablerQuery` . `getIssueEnablersByQuery()` is the basic search method and returns a list of `IssueEnablers` . A more advanced search may be performed with `getIssueEnablersBySearch()` .It accepts an `IssueEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getIssueEnablersBySearch()` returns an `IssueEnablerSearchResults` that can be used to access the resulting `IssueEnablerList` or be used to perform a search within the result set through `IssueEnablerSearch` . This session defines views that offer differing behaviors for searching. federated oubliette view: searches include issue enablers in oubliettes of which this oubliette is an ancestor in the oubliette hierarchy isolated oubliette view: searches are restricted to issue enablers in this oubliette Issue enablers may have a query record indicated by their respective record types. The query record is accessed via the `IssueEnablerQuery` .
Method	getIssueEnablerSearch
Description	Gets an issue enabler search.
Return	`osid.hold.rules.IssueEnablerSearch`		the issue enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getIssueEnablerSearchOrder
Description	Gets an issue enabler search order. The `IssueEnablerSearchOrder` is supplied to an `IssueEnablerSearch` to specify the ordering of results.
Return	`osid.hold.rules.IssueEnablerSearchOrder`		the issue enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getIssueEnablerBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.hold.rules.IssueEnablerQuery`	`issueEnablerQuery`	the issue enabler query
Parameters	`osid.hold.rules.IssueEnablerSearch`	`issueEnablerSearch`	the issue enabler search
Return	`osid.hold.rules.IssueEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`issueEnablerQuery` or `issueEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`issueEnablerQuery` or `issueEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getIssueEnablerQueryFromInspector
Description	Gets an issue enabler query from an inspector. The inspector is available from an `IssueEnablerSearchResults` .
Parameters	`osid.hold.rules.IssueEnablerQueryInspector`	`issueEnablerQueryInspector`	an issue enabler query inspector
Return	`osid.hold.rules.IssueEnablerQuery`		the issue enabler query
Errors	NULL_ARGUMENT		`issueEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`issueEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.