OSID Logo
OSID Specifications
resource demographic package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.demographic.DemographicSearch
Implementsosid.OsidSearch
Description

The search interface for governing demographic searches.

MethodsearchAmongDemographics
Description

Execute this search among the given list of demographics.

Parametersosid.id.IdListdemographicIdslist of demographics
ErrorsNULL_ARGUMENT demographicIds is null
CompliancemandatoryThis method must be implemented.
MethodorderDemographicResults
Description

Specify an ordering to the search results.

Parametersosid.resource.demographic.DemographicSearchOrderdemographicSearchOrderdemographic search order
ErrorsNULL_ARGUMENT demographicSearchOrder is null
UNSUPPORTED demographicSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetDemographicSearchRecord
Description

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

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