OSID - osid.control.ActionGroupSearchSession Service Interface Definition

Interface	osid.control.ActionGroupSearchSession
Implements	`osid.control.ActionGroupQuerySession`
Used By	`osid.control.ControlManager`
Used By	`osid.control.ControlProxyManager`
Description	This session provides methods for searching among `ActionGroups`. The search query is constructed using the `ActionGroupQuery`. `getActionGroupsByQuery()` is the basic search method and returns a list of `ActionGroups`. A more advanced search may be performed with `getActionGroupsBySearch()`.It accepts an `ActionGroupSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getActionGroupsBySearch()` returns an `ActionGroupSearchResults` that can be used to access the resulting `ActionGroupList` or be used to perform a search within the result set through `ActionGroupSearch`. This session defines views that offer differing behaviors for searching. federated system view: searches include action groups in systems of which this system is an ancestor in the system hierarchy isolated system view: searches are restricted to action groups in this system ActionGroups may have a query record indicated by their respective record types. The query record is accessed via the `ActionGroupQuery`.
Method	getActionGroupSearch
Description	Gets an action group search.
Return	`osid.control.ActionGroupSearch`		the action group search
Compliance	`mandatory`		This method must be implemented.
Method	getActionGroupSearchOrder
Description	Gets an action group search order. The `ActionGroupSearchOrder` is supplied to an `ActionGroupSearch` to specify the ordering of results.
Return	`osid.control.ActionGroupSearchOrder`		the action group search order
Compliance	`mandatory`		This method must be implemented.
Method	getActionGroupsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.control.ActionGroupQuery`	`actuionGroupQuery`	the action group query
Parameters	`osid.control.ActionGroupSearch`	`actionGroupSearch`	the action group search
Return	`osid.control.ActionGroupSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`actuionGroupQuery` or `actionGroupSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`actuionGroupQuery` or `actionGroupSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getActionGroupQueryFromInspector
Description	Gets an action group query from an inspector. The inspector is available from an `ActionGroupSearchResults`.
Parameters	`osid.control.ActionGroupQueryInspector`	`actuionGroupQueryInspector`	an action group query inspector
Return	`osid.control.ActionGroupQuery`		the action group query
Errors	NULL_ARGUMENT		`actuionGroupQueryInspector` is `null`
Errors	UNSUPPORTED		`actuionGroupQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.