OSID - osid.authorization.AuthorizationQuerySession Service Interface Definition

Interface	osid.authorization.AuthorizationQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching `Authorization` objects. The search query is constructed using the `AuthorizationQuery.` This session defines views that offer differing behaviors for searching. federated view: searches include authorizations in `Vaults` of which this vault is a ancestor in the vault hierarchy isolated view: searches are restricted to authorizations in this `Vault` implicit authorization view: authorizations include implicit authorizations explicit authorization view: only explicit authorizations are returned
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	canSearchAuthorizations
Description	Tests if this user can perform authorization 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 authorizations 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	useImplicitAuthorizationView
Description	Sets the view for methods in this session to implicit authorizations. An implicit view will include authorizations derived from other authorizations as a result of the `Qualifier,` `Function` or `Resource` hierarchies. This method is the opposite of `explicitAut`
Compliance	`mandatory`		This method is must be implemented.
Method	useExplicitAuthorizationView
Description	Sets the view for methods in this session to explicit authorizations. An explicit view includes only those authorizations that were explicitly defined and not implied. This method is the opposite of `implicitAuthorizationView().`
Compliance	`mandatory`		This method is must be implemented.
Method	getAuthorizationQuery
Description	Gets an authorization query.
Return	`osid.authorization.AuthorizationQuery`		the authorization query
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationsByQuery
Description	Gets a list of `Authorizations` matching the given query.
Parameters	`osid.authorization.AuthorizationQuery`	`authorizationQuery`	the authorization query
Return	`osid.authorization.AuthorizationList`		the returned `AuthorizationList`
Errors	NULL_ARGUMENT		`authorizationQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`authorizationQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.