Interface DemographicEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface DemographicEnablerSearch
extends OsidSearch

The search for governing demographic enabler searches.

Method Summary

Modifier and Type	Method	Description
DemographicEnablerSearchRecord	getDemographicEnablerSearchRecord(Type demographicEnablerSearchRecordType)	Gets the demographic enabler search record corresponding to the given demographic enabler search record Type.
void	orderDemographicEnablerResults(DemographicEnablerSearchOrder demographicEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongDemographicEnablers(IdList demographicEnablerIds)	Execute this search among the given list of demographic enablers.

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

searchAmongDemographicEnablers

void searchAmongDemographicEnablers(IdList demographicEnablerIds)

Execute this search among the given list of demographic enablers.

Parameters:

demographicEnablerIds - list of demographic enablers

Throws:

NullArgumentException - demographicEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderDemographicEnablerResults

void orderDemographicEnablerResults(DemographicEnablerSearchOrder demographicEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

demographicEnablerSearchOrder - demographic enabler search order

Throws:

NullArgumentException - demographicEnablerSearchOrder is null

UnsupportedException - demographicEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getDemographicEnablerSearchRecord

DemographicEnablerSearchRecord getDemographicEnablerSearchRecord(Type demographicEnablerSearchRecordType)
                                                          throws OperationFailedException

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

Parameters:

demographicEnablerSearchRecordType - a demographic enabler search record type

Returns:

the demographic enabler search record

Throws:

NullArgumentException - demographicEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(demographicEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.