OSID - osid.repository.RepositorySearchSession Service Interface Definition

Interface	osid.repository.RepositorySearchSession
Implements	`osid.repository.RepositoryQuerySession`
Used By	`osid.repository.RepositoryManager`
Used By	`osid.repository.RepositoryProxyManager`
Description	This session provides methods for searching among `Repository` objects. The search query is constructed using the `RepositoryQuery`. `getRepositoriesByQuery()` is the basic search method and returns a list of `Repository` objects.A more advanced search may be performed with `getRepositoriesBySearch()`. It accepts a `RepositorySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getRepositoriesBySearch()` returns a `RepositorySearchResults` that can be used to access the resulting `RepositoryList` or be used to perform a search within the result set through `RepositorySearch`. Repositories may have a query record indicated by their respective record types. The query record is accessed via the `RepositoryQuery`.
Method	getRepositorySearch
Description	Gets a repository search.
Return	`osid.repository.RepositorySearch`		the repository search
Compliance	`mandatory`		This method must be implemented.
Method	getRepositorySearchOrder
Description	Gets a repository search order. The `RepositorySearchOrder` is supplied to a `RepositorySearch` to specify the ordering of results.
Return	`osid.repository.RepositorySearchOrder`		the repository search order
Compliance	`mandatory`		This method must be implemented.
Method	getRepositoriesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.repository.RepositoryQuery`	`repositoryQuery`	the repository query
Parameters	`osid.repository.RepositorySearch`	`repositorySearch`	the repository search
Return	`osid.repository.RepositorySearchResults`		the repository search results
Errors	NULL_ARGUMENT		`repositoryQuery` or `repositorySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`repositoryQuery` or `repositorySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRepositoryQueryFromInspector
Description	Gets a repository query from an inspector. The inspector is available from a `RepositorySearchResults`.
Parameters	`osid.repository.RepositoryQueryInspector`	`repositoryQueryInspector`	a repository query inspector
Return	`osid.repository.RepositoryQuery`		the repository query
Errors	NULL_ARGUMENT		`repositoryQueryInspector` is `null`
Errors	UNSUPPORTED		`repositoryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.