OSID - osid.hold.rules.HoldEnablerSearchSession Service Interface Definition

Interface	osid.hold.rules.HoldEnablerSearchSession
Implements	`osid.hold.rules.HoldEnablerQuerySession`
Used By	`osid.hold.rules.HoldRulesManager`
Used By	`osid.hold.rules.HoldRulesProxyManager`
Description	This session provides methods for searching among `HoldEnabler` objects. The search query is constructed using the `HoldEnableryQuery`. `getHoldEnablersByQuery()` is the basic search method and returns a list of `HoldEnablers`. A more advanced search may be performed with `getHoldEnablersBySearch()`.It accepts a `HoldEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getHoldEnablersBySearch()` returns a `HoldEnablerSearchResults` that can be used to access the resulting `HoldEnablerList` or be used to perform a search within the result set through `HoldEnablerSearch`. This session defines views that offer differing behaviors for searching. federated hold view: searches include hold enablers in holds of which this hold is an ancestor in the hold hierarchy isolated hold view: searches are restricted to hold enablers in this hold `HoldEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `HoldEnablerQuery`.
Method	getHoldEnablerSearch
Description	Gets a hold enabler search.
Return	`osid.hold.rules.HoldEnablerSearch`		the hold enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getHoldEnablerSearchOrder
Description	Gets a hold enabler search order. The `HoldEnablerSearchOrder` is supplied to a `HoldEnablerSearch` to specify the ordering of results.
Return	`osid.hold.rules.HoldEnablerSearchOrder`		the hold enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getHoldEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.hold.rules.HoldEnablerQuery`	`holdEnablerQuery`	the hold enabler query
Parameters	`osid.hold.rules.HoldEnablerSearch`	`holdEnablerSearch`	the hold enabler search
Return	`osid.hold.rules.HoldEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`holdEnablerQuery` or `holdEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`holdEnablerQuery` or `holdEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getHoldEnablerQueryFromInspector
Description	Gets a hold enabler query from an inspector. The inspector is available from a `HoldEnablerSearchResults`.
Parameters	`osid.hold.rules.HoldEnablerQueryInspector`	`holdEnablerQueryInspector`	a hold enabler query inspector
Return	`osid.hold.rules.HoldEnablerQuery`		the hold enabler query
Errors	NULL_ARGUMENT		`holdEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`holdEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.