public interface DemographicSearch extends OsidSearch
The search interface for governing demographic searches.
Modifier and Type | Method and Description |
---|---|
DemographicSearchRecord |
getDemographicSearchRecord(Type demographicSearchRecordType)
Gets the demographic search record corresponding to the given
demographic search record
Type. |
void |
orderDemographicResults(DemographicSearchOrder demographicSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongDemographics(IdList demographicIds)
Execute this search among the given list of demographics.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongDemographics(IdList demographicIds)
demographicIds
- list of demographicsNullArgumentException
- demographicIds
is null
mandatory
- This method must be implemented. void orderDemographicResults(DemographicSearchOrder demographicSearchOrder)
demographicSearchOrder
- demographic search orderNullArgumentException
- demographicSearchOrder
is null
UnsupportedException
- demographicSearchOrder
is not of this servicemandatory
- This method must be implemented. DemographicSearchRecord getDemographicSearchRecord(Type demographicSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.demographicSearchRecordType
- a demographic search record typeNullArgumentException
-
demographicSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(demographicSearchRecordType)
is
false
mandatory
- This method must be implemented.