Interface | osid.resource.demographic.DemographicSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing demographic searches. | ||
Method | searchAmongDemographics | ||
Description |
Execute this search among the given list of demographics. | ||
Parameters | osid.id.IdList | demographicIds | list of demographics |
Errors | NULL_ARGUMENT | demographicIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderDemographicResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.resource.demographic.DemographicSearchOrder | demographicSearchOrder | demographic search order |
Errors | NULL_ARGUMENT | demographicSearchOrder is null | |
UNSUPPORTED | demographicSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDemographicSearchRecord | ||
Description |
Gets the demographic search record corresponding to the
given demographic search record | ||
Parameters | osid.type.Type | demographicSearchRecordType | a demographic search record type |
Return | osid.resource.demographic.records.DemographicSearchRecord | the demographic search record | |
Errors | NULL_ARGUMENT | demographicSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(demographicSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |