| Interface | osid.resource.demographic.DemographicSearchSession | ||
|---|---|---|---|
| Implements | osid.resource.demographic.DemographicQuerySession | ||
| Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
| 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 | ||
| 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 |
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 | ||
| Parameters | osid.resource.demographic.DemographicQueryInspector | demographicQueryInspector | a demographic query inspector |
| Return | osid.resource.demographic.DemographicQuery | the demographic query | |
| Errors | NULL_ARGUMENT | demographicQueryInspector is null | |
| UNSUPPORTED | demographicQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |