OSID - osid.authorization.rules.AuthorizationEnablerQuerySession Service Interface Definition

Interface	osid.authorization.rules.AuthorizationEnablerQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.authorization.rules.AuthorizationEnablerSearchSession`
Used By	`osid.authorization.rules.AuthorizationRulesManager`
Used By	`osid.authorization.rules.AuthorizationRulesProxyManager`
Description	This session provides methods for searching among `AuthorizationEnablers`. The search query is constructed using the `AuthorizationEnablerQuery`. This session defines views that offer differing behaviors for searching. federated vault view: searches include authorization enablers in vaults of which this vault is an ancestor in the vault hierarchy isolated vault view: searches are restricted to authorization enablers in this vault Authorization enablers may have a query record indicated by their respective record types. The query record is accessed via the `AuthorizationEnablerQuery`.
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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchAuthorizationEnablers
Description	Tests if this user can perform `AuthorizationEnabler` lookups. 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 not offer lookup 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 authorization enablers in vaults which are children of this broker 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 lookups to this vault only.
Compliance	`mandatory`		This method is must be implemented.
Method	getAuthorizationEnablerQuery
Description	Gets an authorization enabler query.
Return	`osid.authorization.rules.AuthorizationEnablerQuery`		the authorization enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationEnablersByQuery
Description	Gets a list of `AuthorizationEnablers` matching the given search.
Parameters	`osid.authorization.rules.AuthorizationEnablerQuery`	`authorizationEnablerQuery`	the search query
Return	`osid.authorization.rules.AuthorizationEnablerList`		the returned `AuthorizationEnablerList`
Errors	NULL_ARGUMENT		`authorizationEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`authorizationEnablerQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.