OSID - osid.authorization.VaultQuerySession Service Interface Definition

Interface	osid.authorization.VaultQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.authorization.VaultSearchSession`
Used By	`osid.authorization.AuthorizationManager`
Used By	`osid.authorization.AuthorizationProxyManager`
Description	This session provides methods for searching among `Vault` objects. The search query is constructed using the `VaultQuery`. Vaults may have a query record indicated by their respective record types. The query record is accessed via the `VaultQuery`.
Method	canSearchVaults
Description	Tests if this user can perform `Vault` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getVaultQuery
Description	Gets a vault query.
Return	`osid.authorization.VaultQuery`		a vault query
Compliance	`mandatory`		This method must be implemented.
Method	getVaultsByQuery
Description	Gets a list of `Vault` objects matching the given search.
Parameters	`osid.authorization.VaultQuery`	`vaultQuery`	the vault query
Return	`osid.authorization.VaultList`		the returned `VaultList`
Errors	NULL_ARGUMENT		`vaultQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`vaultQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.