OSID Logo
OSID Specifications
resource demographic package
Version 3.1.0
Interfaceosid.resource.demographic.DemographicSearchResults
Implementsosid.OsidSearchResults
Used Byosid.resource.demographic.DemographicSearchSession
Description

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

MethodgetDemographics
Description

Gets the DemographicList resulting from a search.

Returnosid.resource.demographic.DemographicList the demographic list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetDemographicQueryInspector
Description

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

Returnosid.resource.demographic.DemographicQueryInspector the demographic query inspector
Compliancemandatory This 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.TypedemographicSearchRecordType a demographic search record type
Returnosid.resource.demographic.records.DemographicSearchResultsRecord the demographic search results record
ErrorsNULL_ARGUMENT demographicSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(demographicSearchRecordType) is false
Compliancemandatory This method must be implemented.