Interface ModelSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ModelSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ModelQueryInspector	getModelQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ModelList	getModels()	Gets the model list resulting from a search.
ModelSearchResultsRecord	getModelSearchResultsRecord(Type modelSearchRecordType)	Gets the model search results record corresponding to the given model search record Type .This method is 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

getModels

ModelList getModels()

Gets the model list resulting from a search.

Returns:

the model list

Throws:

IllegalStateException - the model list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getModelQueryInspector

ModelQueryInspector getModelQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getModelSearchResultsRecord

ModelSearchResultsRecord getModelSearchResultsRecord(Type modelSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

modelSearchRecordType - a model search record type

Returns:

the model search results record

Throws:

NullArgumentException - modelSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(modelSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.