OSID - osid.resource.demographic.DemographicEnablerSearchSession Service Interface Definition

Interface	osid.resource.demographic.DemographicEnablerSearchSession
Implements	`osid.resource.demographic.DemographicEnablerQuerySession`
Used By	`osid.resource.demographic.ResourceDemographicManager`
Used By	`osid.resource.demographic.ResourceDemographicProxyManager`
Description	This session provides methods for searching among `DemographicEnablers` . The search query is constructed using the `DemographicEnableryQuery` . `getDemographicEnablersByQuery()` is the basic search method and returns a list of `DemographicEnablers` . A more advanced search may be performed with `getDemographicEnablersBySearch()` . It accepts a `DemographicEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as bin. `getDemographicEnablersBySearch()` returns a `DemographicEnablerSearchResults` that can be used to access the resulting `DemographicEnablerList` or be used to perform a search within the result set through `DemographicEnablerSearch` . This session defines views that offer differing behaviors for searching. federated bin view: searches include demographic enablers in bins of which this bin is an ancestor in the bin hierarchy isolated bin view: searches are restricted to demographic enablers in this bin `DemographicEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `DemographicEnablerQuery` .
Method	getDemographicEnablerSearch
Description	Gets a demographic enabler search.
Return	`osid.resource.demographic.DemographicEnablerSearch`		the demographic enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicEnablerSearchOrder
Description	Gets a demographic enabler search order. The `DemographicEnablerSearchOrder` is supplied to a `DemographicEnablerSearch` to specify the ordering of results.
Return	`osid.resource.demographic.DemographicEnablerSearchOrder`		the demographic enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.resource.demographic.DemographicEnablerQuery`	`demographicEnablerQuery`	the demographic enabler query
Parameters	`osid.resource.demographic.DemographicEnablerSearch`	`demographicEnablerSearch`	the demographic enabler search
Return	`osid.resource.demographic.DemographicEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`demographicEnablerQuery` or `demographicEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`demographicEnablerQuery` or `demographicEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicEnablerQueryFromInspector
Description	Gets a demographic enabler query from an inspector. The inspector is available from a `DemographicEnablerSearchResults` .
Parameters	`osid.resource.demographic.DemographicEnablerQueryInspector`	`demographicEnablerQueryInspector`	a demographic enabler query inspector
Return	`osid.resource.demographic.DemographicEnablerQuery`		the demographic enabler query
Errors	NULL_ARGUMENT		`demographicEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`demographicEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.