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

Interface	osid.hold.rules.IssueConstrainerEnablerSearchSession
Implements	`osid.hold.rules.IssueConstrainerEnablerQuerySession`
Used By	`osid.hold.rules.HoldRulesManager`
Used By	`osid.hold.rules.HoldRulesProxyManager`
Description	This session provides methods for searching among `IssueConstrainerEnablers` . The search query is constructed using the `IssueConstrainerEnablerQuery` . `getIssueConstrainerEnablersByQuery()` is the basic search method and returns a list of `IssueConstrainerEnablers` . A more advanced search may be performed with `getIssueConstrainerEnablersBySearch()` .It accepts an `IssueConstrainerEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getIssueConstrainerEnablersBySearch()` returns an `IssueConstrainerEnablerSearchResults` that can be used to access the resulting `IssueConstrainerEnablerList` or be used to perform a search within the result set through `IssueConstrainerEnablerSearch` . This session defines views that offer differing behaviors for searching. federated oubliette view: searches include issue constrainer enablers in oubliettes of which this oubliette is an ancestor in the oubliette hierarchy isolated oubliette view: searches are restricted to issue constrainer enablers in this oubliette Issue constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the `IssueConstrainerEnablerQuery` .
Method	getIssueConstrainerEnablerSearch
Description	Gets an issue constrainer enabler search.
Return	`osid.hold.rules.IssueConstrainerEnablerSearch`		the issue constrainer enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getIssueConstrainerEnablerSearchOrder
Description	Gets an issue constrainer enabler search order. The `IssueConstrainerEnablerSearchOrder` is supplied to an `IssueConstrainerEnablerSearch` to specify the ordering of results.
Return	`osid.hold.rules.IssueConstrainerEnablerSearchOrder`		the issue constrainer enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getIssueConstrainerEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.hold.rules.IssueEnablerQuery`	`issueConstrainerEnablerQuery`	the issue constrainer enabler query
Parameters	`osid.hold.rules.IssueConstrainerEnablerSearch`	`issueConstrainerEnablerSearch`	the issue constrainer enabler search
Return	`osid.hold.rules.IssueConstrainerEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`issueConstrainerEnablerQuery` or `issueConstrainerEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`issueConstrainerEnablerQuery` or `issueConstrainerEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getIssueConstrainerEnablerQueryFromInspector
Description	Gets an issue constrainer enabler query from an inspector. The inspector is available from an `IssueConstrainerEnablerSearchResults` .
Parameters	`osid.hold.rules.IssueConstrainerEnablerQueryInspector`	`issueConstrainerEnablerQueryInspector`	an issue constrainer enabler query inspector
Return	`osid.hold.rules.IssueConstrainerEnablerQuery`		the issue constrainer enabler query
Errors	NULL_ARGUMENT		`issueConstrainerEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`issueConstrainerEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.