OSID - osid.resourcing.rules.AvailabilityEnablerSearchSession Service Interface Definition

Interface	osid.resourcing.rules.AvailabilityEnablerSearchSession
Implements	`osid.resourcing.rules.AvailabilityEnablerQuerySession`
Used By	`osid.resourcing.rules.ResourcingRulesManager`
Used By	`osid.resourcing.rules.ResourcingRulesProxyManager`
Description	This session provides methods for searching among `AvailabilityEnabler` objects. The search query is constructed using the `AvailabilityEnableryQuery` . `getAvailabilityEnablersByQuery()` is the basic search method and returns a list of `AvailabilityEnablers` . A more advanced search may be performed with `getAvailabilityEnablersBySearch()` . It accepts an `AvailabilityEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as resourcing. `getAvailabilityEnablersBySearch()` returns an `AvailabilityEnablerSearchResults` that can be used to access the resulting `AvailabilityEnablerList` or be used to perform a search within the result set through `AvailabilityEnablerSearch` . This session defines views that offer differing behaviors for searching. federated foundry view: searches include availability enablers in foundries of which this foundry is an ancestor in the foundry hierarchy isolated foundry view: searches are restricted to availability enablers in this foundry `AvailabilityEnablers` may have an availability enabler query record indicated by their respective record types. The availability enabler record query is accessed via the `AvailabilityEnablerQuery` .
Method	getAvailabilityEnablerSearch
Description	Gets an availability enabler search.
Return	`osid.resourcing.rules.AvailabilityEnablerSearch`		the availability enabler search.
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityEnablerSearchOrder
Description	Gets an availability enabler search order. The `AvailabilityEnablerSearchOrder` is supplied to an `AvailabilityEnablerSearch` to specify the ordering of results.
Return	`osid.resourcing.rules.AvailabilityEnablerSearchOrder`		the availability enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.resourcing.rules.AvailabilityEnablerQuery`	`availabilityEnablerQuery`	the availability enabler query
Parameters	`osid.resourcing.rules.AvailabilityEnablerSearch`	`availabilityEnablerSearch`	the availability enabler search
Return	`osid.resourcing.rules.AvailabilityEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`availabilityEnablerQuery` or `availabilityEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`availabilityEnablerQuery` or `availabilityEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityEnablerQueryFromInspector
Description	Gets an availability enabler query from an inspector. The inspector is available from an `AvailabilityEnablerSearchResults` .
Parameters	`osid.resourcing.rules.AvailabilityEnablerQueryInspector`	`availabilityEnablerQueryInspector`	an availability enabler query inspector
Return	`osid.resourcing.rules.AvailabilityEnablerQuery`		the availability enabler query
Errors	NULL_ARGUMENT		`availabilityEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`availabilityEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.