org.osid.resource.demographic

Interface DemographicEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface DemographicEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
DemographicEnablerQueryInspector	getDemographicEnablerQueryInspector() Gets the inspector for the query to examine the terms used in the search.
DemographicEnablerList	getDemographicEnablers() Gets the DemographicEnablerList resulting from a search.
DemographicEnablerSearchResultsRecord	getDemographicEnablerSearchResultsRecord(Type demographicEnablerSearchRecordType) Gets the demographic enabler search results record corresponding to the given demographic enabler 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

getDemographicEnablers

DemographicEnablerList getDemographicEnablers()

Gets the DemographicEnablerList resulting from a search.

Returns:

the demographic enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getDemographicEnablerQueryInspector

DemographicEnablerQueryInspector getDemographicEnablerQueryInspector()

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

Returns:

the demographic enabler query inspector

Compliance:

mandatory - This method must be implemented.

getDemographicEnablerSearchResultsRecord

DemographicEnablerSearchResultsRecord getDemographicEnablerSearchResultsRecord(Type demographicEnablerSearchRecordType)
                                                                               throws OperationFailedException,
                                                                                      PermissionDeniedException

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

Parameters:

demographicEnablerSearchRecordType - a demographic enabler search record type

Returns:

the demographic enabler search results record

Throws:

NullArgumentException - demographicEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(demographicEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.