org.osid.configuration

Interface ConfigurationSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ConfigurationSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
ConfigurationQueryInspector	getConfigurationQueryInspector() Gets the inspector for the query to examine the terms used in the search.
ConfigurationList	getConfigurations() Gets the configuration list resulting from a search.
ConfigurationSearchResultsRecord	getConfigurationSearchResultsRecord(Type configurationSearchRecordType) Gets the configuration search results record corresponding to the given configuration 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

getConfigurations

ConfigurationList getConfigurations()

Gets the configuration list resulting from a search.

Returns:

the configuration list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getConfigurationQueryInspector

ConfigurationQueryInspector getConfigurationQueryInspector()

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

Returns:

the configuration query inspector

Compliance:

mandatory - This method must be implemented.

getConfigurationSearchResultsRecord

ConfigurationSearchResultsRecord getConfigurationSearchResultsRecord(Type configurationSearchRecordType)
                                                                     throws OperationFailedException

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

Parameters:

configurationSearchRecordType - a configuration search record type

Returns:

the configuration search results

Throws:

NullArgumentException - configurationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(configurationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.