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

Interface	osid.hold.rules.IssueConstrainerSearchSession
Implements	`osid.hold.rules.IssueConstrainerQuerySession`
Used By	`osid.hold.rules.HoldRulesManager`
Used By	`osid.hold.rules.HoldRulesProxyManager`
Description	This session provides methods for searching among `IssueConstrainers` . The search query is constructed using the `IssueConstrainerQuery` . `getIssueConstrainersByQuery()` is the basic search method and returns a list of `IssueConstrainers` . A more advanced search may be performed with `getIssueConstrainersBySearch()` . It accepts an `IssueConstrainerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getIssueConstrainersBySearch()` returns an `IssueConstrainerSearchResults` that can be used to access the resulting `IssueConstrainerList` or be used to perform a search within the result set through `IssueConstrainerSearch` . This session defines views that offer differing behaviors for searching. federated oubliette view: searches include issue constrainers in oubliettes of which this oubliette is an ancestor in the oubliette hierarchy isolated oubliette view: searches are restricted to issue constrainers in this oubliette Issue constrainers may have a query record indicated by their respective record types. The query record is accessed via the `IssueConstrainerQuery` .
Method	getIssueConstrainerSearch
Description	Gets an issue constrainer search.
Return	`osid.hold.rules.IssueConstrainerSearch`		the issue constrainer search
Compliance	`mandatory`		This method must be implemented.
Method	getIssueConstrainerSearchOrder
Description	Gets an issue constrainer search order. The `IssueConstrainerSearchOrder` is supplied to an `IssueConstrainerSearch` to specify the ordering of results.
Return	`osid.hold.rules.IssueConstrainerSearchOrder`		the issue constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	getIssueConstrainerBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.hold.rules.IssueConstrainerQuery`	`issueConstrainerQuery`	the issue constrainer query
Parameters	`osid.hold.rules.IssueConstrainerSearch`	`issueConstrainerSearch`	the issue constrainer search
Return	`osid.hold.rules.IssueConstrainerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`issueConstrainerQuery` or `issueConstrainerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`issueConstrainerQuery` or `issueConstrainerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getIssueConstrainerQueryFromInspector
Description	Gets an issue constrainer query from an inspector. The inspector is available from an `IssueConstrainerSearchResults` .
Parameters	`osid.hold.rules.IssueConstrainerQueryInspector`	`issueConstrainerQueryInspector`	an issue constrainer query inspector
Return	`osid.hold.rules.IssueConstrainerQuery`		the issue constrainer query
Errors	NULL_ARGUMENT		`issueConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`issueConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.