OSID - osid.tracking.IssueSearchSession Service Interface Definition

Interface	osid.tracking.IssueSearchSession
Implements	`osid.tracking.IssueQuerySession`
Used By	`osid.tracking.TrackingManager`
Used By	`osid.tracking.TrackingProxyManager`
Description	This session provides methods for searching among `Issue` objects. The search query is constructed using the `IssueQuery` . `getIssuesByQuery()` is the basic search method and returns a list of `Issues` . A more advanced search may be performed with `getIssuesBySearch()` . It accepts an `IssueSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getIssuesBySearch()` returns an `IssueSearchResults` that can be used to access the resulting `IssueList` or be used to perform a search within the result set through `IssueSearch` . This session defines views that offer differing behaviors for searching. federated front office view: searches include issues in front offices of which this front office is an ancestor in the front office hierarchy isolated front office view: searches are restricted to issues in this frontOffice Issues may have a query record indicated by their respective record types. The query record is accessed via the `IssueQuery` .
Method	getIssueSearch
Description	Gets an issue search.
Return	`osid.tracking.IssueSearch`		the issue search
Compliance	`mandatory`		This method must be implemented.
Method	getIssueSearchOrder
Description	Gets an issue search order. The `IssueSearchOrder` is supplied to an `IssueSearch` to specify the ordering of results.
Return	`osid.tracking.IssueSearchOrder`		the issue search order
Compliance	`mandatory`		This method must be implemented.
Method	getIssuesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.tracking.IssueQuery`	`issueQuery`	the issue query
Parameters	`osid.tracking.IssueSearch`	`issueSearch`	the issue search
Return	`osid.tracking.IssueSearchResults`		the issue search results
Errors	NULL_ARGUMENT		`issueQuery` or `issueSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`issueQuery` or `issueSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getIssueQueryFromInspector
Description	Gets an issue query from an inspector. The inspector is available from a `IssueSearchResults` .
Parameters	`osid.tracking.IssueQueryInspector`	`issueQueryInspector`	an issue query inspector
Return	`osid.tracking.IssueQuery`		the issue query
Errors	NULL_ARGUMENT		`issueQueryInspector` is `null`
Errors	UNSUPPORTED		`issueQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.