OSID - osid.authentication.keys.KeySearchSession Service Interface Definition

Interface	osid.authentication.keys.KeySearchSession
Implements	`osid.authentication.keys.KeyQuerySession`
Used By	`osid.authentication.keys.AuthenticationKeysManager`
Used By	`osid.authentication.keys.AuthenticationKeysProxyManager`
Description	This session provides methods for searching `Keys`. The search query is constructed using the `KeyQuery`. The key record `Type` also specifies the record for the key query. `getKeysByQuery()` is the basic search method and returns a list of `Keys`. A more advanced search may be performed with `getKeysBySearch()`. It accepts an `KeySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getKeysBySearch()` returns a `KeySearchResult` that can be used to access the resulting `KeyList` or be used to perform a search within the result set through `KeySearch`. This session defines views that offer differing behaviors for searching. federated agency view: searches include keys in agencies of which this agency is a ancestor in the agency hierarchy isolated agency view: searches are restricted to agents in this agency Keys may have a query record indicated by their respective record types. The query record is accessed via the KeyQuery.
Method	getKeySearch
Description	Gets a key query.
Return	`osid.authentication.keys.KeySearch`		the key search
Compliance	`mandatory`		This method must be implemented.
Method	getKeySearchOrder
Description	Gets a key search order. The `KeySearchOrder` is supplied to a `KeySearch` to specify the ordering of results.
Return	`osid.authentication.keys.KeySearchOrder`		the key search order
Compliance	`mandatory`		This method must be implemented.
Method	getKeysBySearch
Description	Gets a list of `Keys` matching the given search.
Parameters	`osid.authentication.keys.KeyQuery`	`keyQuery`	the key query
Parameters	`osid.authentication.keys.KeySearch`	`keySearch`	the key search
Return	`osid.authentication.keys.KeySearchResults`		the returned search results
Errors	NULL_ARGUMENT		`keyQuery` or `keySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`keySearch` or a `keyQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getKeyQueryFromInspector
Description	Gets a key query from an inspector. The inspector is available from an `KeySearchResults`.
Parameters	`osid.authentication.keys.KeyQueryInspector`	`keyQueryInspector`	a query inspector
Return	`osid.authentication.keys.KeyQuery`		the key query
Errors	NULL_ARGUMENT		`keyQueryInspector` is `null`
Errors	UNSUPPORTED		`keyQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.