OSID - osid.authorization.FunctionQuerySession Service Interface Definition

Interface	osid.authorization.FunctionQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching `Function` objects. The search query is constructed using the `FunctionQuery.` The function record `Type` also specifies the query record for the function query. This session defines views that offer differing behaviors for searching. federated vault view: searches include functions in vaults of which this vault is a ancestor in the vault hierarchy isolated vault view: searches are restricted to functions in this vault Functions may have a query record indicated by their respective record types. The query record is accessed via the `FunctionQuery.`
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	canSearchFunctions
Description	Tests if this user can perform `Function` 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 functions 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	getFunctionQuery
Description	Gets a function query.
Return	`osid.authorization.FunctionQuery`		the function query
Compliance	`mandatory`		This method must be implemented.
Method	getFunctionsByQuery
Description	Gets a list of `Functions` matching the given query.
Parameters	`osid.authorization.FunctionQuery`	`functionQuery`	the function query
Return	`osid.authorization.FunctionList`		the returned `FunctionList`
Errors	NULL_ARGUMENT		`functionQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`functionQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.