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

Interface	osid.authorization.rules.AuthorizationEnablerSearchSession
Implements	`osid.authorization.rules.AuthorizationEnablerQuerySession`
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 `AuthorizationEnableryQuery` . `getAuthorizationEnablersByQuery()` is the basic search method and returns a list of `AuthorizationEnablers` . A more advanced search may be performed with `getAuthorizationEnablersBySearch()` . It accepts an `AuthorizationEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getAuthorizationEnablersBySearch()` returns an `AuthorizationEnablerSearchResults` that can be used to access the resulting `AuthorizationEnablerList` or be used to perform a search within the result set through `AuthorizationEnablerSearch` . 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 `AuthorizationEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `AuthorizationEnablerQuery` .
Method	getAuthorizationEnablerSearch
Description	Gets an authorization enabler search.
Return	`osid.authorization.rules.AuthorizationEnablerSearch`		the authorization enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationEnablerSearchOrder
Description	Gets an authorization enabler search order. The `AuthorizationEnablerSearchOrder` is supplied to an `AuthorizationEnablerSearch` to specify the ordering of results.
Return	`osid.authorization.rules.AuthorizationEnablerSearchOrder`		the authorization enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.authorization.rules.AuthorizationEnablerQuery`	`authorizationEnablerQuery`	the authorization enabler query
Parameters	`osid.authorization.rules.AuthorizationEnablerSearch`	`authorizationEnablerSearch`	the authorization enabler search
Return	`osid.authorization.rules.AuthorizationEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`authorizationEnablerQuery` or `authorizationEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`authorizationEnablerQuery` or `authorizationEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationEnablerQueryFromInspector
Description	Gets an authorization enabler query from an inspector. The inspector is available from an `AuthorizationEnablerSearchResults` .
Parameters	`osid.authorization.rules.AuthorizationEnablerQueryInspector`	`authorizationEnablerQueryInspector`	an authorization enabler query inspector
Return	`osid.authorization.rules.AuthorizationEnablerQuery`		the authorization enabler query
Errors	NULL_ARGUMENT		`authorizationEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`authorizationEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.