org.osid.resource.demographic

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

Methods

Modifier and Type	Method and 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.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

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.