OSID - osid.authorization.FunctionSearchSession Service Interface Definition

Interface	osid.authorization.FunctionSearchSession
Implements	`osid.authorization.FunctionQuerySession`
Description	This session provides methods for searching `Function` objects. The search query is constructed using the `FunctionQuery.` The function record `Type` also specifies the record for the function query. `getFunctionsByQuery()` is the basic search method and returns a list of `Functions.` A more advanced search may be performed with `getFunctionsBySearch().` It accepts a `FunctionSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getFunctionsBySearch()` returns an `FunctionSearchResults` that can be used to access the resulting `FunctionList` or be used to perform a search within the result set through `FunctionSearch.` 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	getFunctionSearch
Description	Gets a function search.
Return	`osid.authorization.FunctionSearch`		the function search
Compliance	`mandatory`		This method must be implemented.
Method	getFunctionSearchOrder
Description	Gets a function search order. The `FunctionSearchOrder` is supplied to a `FunctionSearch` to specify the ordering of results.
Return	`osid.authorization.FunctionSearchOrder`		the function search order
Compliance	`mandatory`		This method must be implemented.
Method	getFunctionsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.authorization.FunctionQuery`	`functionQuery`	the function query
Parameters	`osid.authorization.FunctionSearch`	`functionSearch`	the function search
Return	`osid.authorization.FunctionSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`functionQuery` or `functionSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`functionSearch` or `functionQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getFunctionQueryFromInspector
Description	Gets a function query from an inspector. The inspector is available from a `FunctionSearchResults.`
Parameters	`osid.authorization.FunctionQueryInspector`	`functionQueryInspector`	a function query inspector
Return	`osid.authorization.FunctionQuery`		the function query
Errors	NULL_ARGUMENT		`functionQueryInspector` is `null`
Errors	UNSUPPORTED		`functionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.