OSID - osid.authorization.VaultSearchSession Service Interface Definition

Interface	osid.authorization.VaultSearchSession
Implements	`osid.authorization.VaultQuerySession`
Description	This session provides methods for searching among `Vault` objects. The search query is constructed using the `VaultQuery.` `getVaultsByQuery()` is the basic search method and returns a list of `Vault` objects.A more advanced search may be performed with `getVaultsBySearch().` It accepts a `VaultSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getVaultsBySearch()` returns a `VaultSearchResults` that can be used to access the resulting `VaultList` or be used to perform a search within the result set through `VaultSearch.` Vaults may have a query record indicated by their respective record types. The query record is accessed via the `VaultQuery.`
Method	getVaultSearch
Description	Gets a vault search.
Return	`osid.authorization.VaultSearch`		a vault search
Compliance	`mandatory`		This method must be implemented.
Method	getVaultSearchOrder
Description	Gets a vault search order. The `VaultSearchOrder` is supplied to a `VaultSearch` to specify the ordering of results.
Return	`osid.authorization.VaultSearchOrder`		the vault search order
Compliance	`mandatory`		This method must be implemented.
Method	getVaultsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.authorization.VaultQuery`	`vaultQuery`	the vault query
Parameters	`osid.authorization.VaultSearch`	`vaultSearch`	the vault search
Return	`osid.authorization.VaultSearchResults`		the search results
Errors	NULL_ARGUMENT		`vaultQuery` or `vaultSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`vaultQuery` or `vaultSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getVaultQueryFromInspector
Description	Gets a vault query from an inspector. The inspector is available from a `VaultSearchResults.`
Parameters	`osid.authorization.VaultQueryInspector`	`vaultQueryInspector`	a vault query inspector
Return	`osid.authorization.VaultQuery`		the vault query
Errors	NULL_ARGUMENT		`vaultQueryInspector` is `null`
Errors	UNSUPPORTED		`vaultQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.