OSID - osid.authorization.QualifierQuerySession Service Interface Definition

Interface	osid.authorization.QualifierQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.authorization.QualifierSearchSession`
Used By	`osid.authorization.AuthorizationManager`
Used By	`osid.authorization.AuthorizationProxyManager`
Description	This session provides methods for searching among `Qualifier` objects. The search query is constructed using the `QualifierQuery`. If more than one search element is specified within a single `QualifierQuery`, these elements form a boolean AND. This session defines views that offer differing behaviors for searching. federated vault view: searches include qualifiers in vaults of which this vault is an ancestor in the vault hierarchy isolated vault view: searches are restricted to qualifiers in this vault Qualifiers may have a query record indicated by their respective record types. The query record is accessed via the `QualifierQuery`.
Method	getVaultId
Description	Gets the `Vault` `Id` associated with this session.
Return	`osid.id.Id`		the `Vault Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getVault
Description	Gets the `Vault` associated with this session.
Return	`osid.authorization.Vault`		the `Vault` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchQualifiers
Description	Tests if this user can perform `Qualifier` 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	useFederatedVaultView
Description	Federates the view for methods in this session. A federated view will include qualifiers in vaults which are children of this vault in the vault hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedVaultView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this vault only.
Compliance	`mandatory`		This method is must be implemented.
Method	getQualifierQuery
Description	Gets a qualifier query.
Return	`osid.authorization.QualifierQuery`		the qualifier query
Compliance	`mandatory`		This method must be implemented.
Method	getQualifiersByQuery
Description	Gets a list of `Qualifiers` matching the given search.
Parameters	`osid.authorization.QualifierQuery`	`qualifierQuery`	the search query array
Return	`osid.authorization.QualifierList`		the returned `QualifierList`
Errors	NULL_ARGUMENT		`qualifierQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`qualifierQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.