Interface | osid.resource.demographic.DemographicSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getDemographics | ||
Description |
Gets the | ||
Return | osid.resource.demographic.DemographicList | the demographic list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getDemographicQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.resource.demographic.DemographicQueryInspector | the demographic query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getDemographicSearchResultsRecord | ||
Description |
Gets the demographic search results record
corresponding to the given demographic search record
| ||
Parameters | osid.type.Type | demographicSearchRecordType | a demographic search record type |
Return | osid.resource.demographic.records.DemographicSearchResultsRecord | the demographic search results record | |
Errors | NULL_ARGUMENT | demographicSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(demographicSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |