OSID - osid.authorization.QualifierSearchSession Service Interface Definition

Interface	osid.authorization.QualifierSearchSession
Implements	`osid.authorization.QualifierQuerySession`
Used By	`osid.authorization.AuthorizationManager`
Used By	`osid.authorization.AuthorizationProxyManager`
Description	This session provides methods for searching among `Qualifier` objects. The search query is constructed using the `QualifierQuery`. If more than one search element is specified within a single `QualifierQuery`, these elements form a boolean AND. `getQualifiersByQuery()` is the basic search method and returns a list of `Qualifiers`. A more advanced search may be performed with `getQualifiersBySearch()`.It accepts a `QualifierSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getQualifiersBySearch()` returns a `QualifierSearchResults` that can be used to access the resulting `QualifierList` or be used to perform a search within the result set through `QualifierSearch`. This session defines views that offer differing behaviors for searching. federated vault view: searches include qualifiers in vaults of which this vault is an ancestor in the vault hierarchy isolated vault view: searches are restricted to qualifiers in this vault Qualifiers may have a query record indicated by their respective record types. The query record is accessed via the `QualifierQuery`.
Method	getQualifierSearch
Description	Gets a qualifier search.
Return	`osid.authorization.QualifierSearch`		the qualifier search
Compliance	`mandatory`		This method must be implemented.
Method	getQualifierSearchOrder
Description	Gets a qualifier search order. The `QualifierSearchOrder` is supplied to a `QualifierSearch` to specify the ordering of results.
Return	`osid.authorization.QualifierSearchOrder`		the qualifier search order
Compliance	`mandatory`		This method must be implemented.
Method	getQualifiersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.authorization.QualifierQuery`	`qualifierQuery`	the qualifier query
Parameters	`osid.authorization.QualifierSearch`	`qualifierSearch`	the qualifier search
Return	`osid.authorization.QualifierSearchResults`		the search results
Errors	NULL_ARGUMENT		`qualifierQueriy` or `qualifierSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`qualifierQuery` or `qualifierSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getQualifierQueryFromInspector
Description	Gets a qualifier query from an inspector. The inspector is available from a `QualifierSearchResults`.
Parameters	`osid.authorization.QualifierQueryInspector`	`qualifierQueryInspector`	a qualifier query inspector
Return	`osid.authorization.QualifierQuery`		the qualifier query
Errors	NULL_ARGUMENT		`qualifierQueryInspector` is `null`
Errors	UNSUPPORTED		`qualifierQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.