OSID Logo
OSID Specifications
resource demographic package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.demographic.DemographicSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetDemographics
Description

Gets the DemographicList resulting from a search.

Returnosid.resource.demographic.DemographicListthe demographic list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetDemographicQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.resource.demographic.DemographicQueryInspectorthe demographic query inspector
CompliancemandatoryThis method must be implemented.
MethodgetDemographicSearchResultsRecord
Description

Gets the demographic search results record corresponding to the given demographic search record Type. This method must be used to retrieve an object implementing the requested record.

Parametersosid.type.TypedemographicSearchRecordTypea demographic search record type
Returnosid.resource.demographic.records.DemographicSearchResultsRecordthe demographic search results record
ErrorsNULL_ARGUMENT demographicSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(demographicSearchRecordType) is false
CompliancemandatoryThis method must be implemented.