Interface DemographicSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface DemographicSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
DemographicQueryInspector	getDemographicQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
DemographicList	getDemographics()	Gets the DemographicList resulting from a search.
DemographicSearchResultsRecord	getDemographicSearchResultsRecord(Type demographicSearchRecordType)	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.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getDemographics

DemographicList getDemographics()

Gets the DemographicList resulting from a search.

Returns:

the demographic list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getDemographicQueryInspector

DemographicQueryInspector getDemographicQueryInspector()

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

Returns:

the demographic query inspector

Compliance:

mandatory - This method must be implemented.

getDemographicSearchResultsRecord

DemographicSearchResultsRecord getDemographicSearchResultsRecord(Type demographicSearchRecordType)
                                                          throws OperationFailedException,
PermissionDeniedException

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.

Parameters:

demographicSearchRecordType - a demographic search record type

Returns:

the demographic search results record

Throws:

NullArgumentException - demographicSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(demographicSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.