Interface DemographicSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface DemographicSearch
extends OsidSearch

The search interface for governing demographic searches.

Method Summary

Modifier and Type	Method	Description
DemographicSearchRecord	getDemographicSearchRecord(Type demographicSearchRecordType)	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.
void	orderDemographicResults(DemographicSearchOrder demographicSearchOrder)	Specify an ordering to the search results.
void	searchAmongDemographics(IdList demographicIds)	Execute this search among the given list of demographics.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongDemographics

void searchAmongDemographics(IdList demographicIds)

Execute this search among the given list of demographics.

Parameters:

demographicIds - list of demographics

Throws:

NullArgumentException - demographicIds is null

Compliance:

mandatory - This method must be implemented.

orderDemographicResults

void orderDemographicResults(DemographicSearchOrder demographicSearchOrder)

Specify an ordering to the search results.

Parameters:

demographicSearchOrder - demographic search order

Throws:

NullArgumentException - demographicSearchOrder is null

UnsupportedException - demographicSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getDemographicSearchRecord

DemographicSearchRecord getDemographicSearchRecord(Type demographicSearchRecordType)
                                            throws OperationFailedException

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.

Parameters:

demographicSearchRecordType - a demographic search record type

Returns:

the demographic search record

Throws:

NullArgumentException - demographicSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(demographicSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.