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

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

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.