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

Interface	osid.resource.demographic.DemographicSearchSession
Implements	`osid.resource.demographic.DemographicQuerySession`
Used By	`osid.resource.demographic.ResourceDemographicManager`
Used By	`osid.resource.demographic.ResourceDemographicProxyManager`
Description	This session provides methods for searching among `Demographics` . The search query is constructed using the `DemographicyQuery` . `getDemographicsByQuery()` is the basic search method and returns a list of `Demographics` . A more advanced search may be performed with `getDemographicsBySearch()` .It accepts a `DemographicSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as bin. `getDemographicsBySearch()` returns a `DemographicSearchResults` that can be used to access the resulting `DemographicList` or be used to perform a search within the result set through `DemographicSearch` . This session defines views that offer differing behaviors for searching. federated bin view: searches include demographic in bins of which this bin is an ancestor in the bin hierarchy isolated bin view: searches are restricted to demographic in this bin `Demographics` may have a query record indicated by their respective record types. The query record is accessed via the `DemographicQuery` .
Method	getDemographicSearch
Description	Gets a demographic search.
Return	`osid.resource.demographic.DemographicSearch`		the demographic search
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicSearchOrder
Description	Gets a demographic search order. The `DemographicSearchOrder` is supplied to a `DemographicSearch` to specify the ordering of results.
Return	`osid.resource.demographic.DemographicSearchOrder`		the demographic search order
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.resource.demographic.DemographicQuery`	`demographicQuery`	the demographic query
Parameters	`osid.resource.demographic.DemographicSearch`	`demographicSearch`	the demographic search
Return	`osid.resource.demographic.DemographicSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`demographicQuery` or `demographicSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`demographicQuery` or `demographicSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicQueryFromInspector
Description	Gets a demographic query from an inspector. The inspector is available from a `DemographicSearchResults` .
Parameters	`osid.resource.demographic.DemographicQueryInspector`	`demographicQueryInspector`	a demographic query inspector
Return	`osid.resource.demographic.DemographicQuery`		the demographic query
Errors	NULL_ARGUMENT		`demographicQueryInspector` is `null`
Errors	UNSUPPORTED		`demographicQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.