Interface AntimatroidSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AntimatroidSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
AntimatroidQueryInspector	getAntimatroidQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
AntimatroidList	getAntimatroids()	Gets the antimatroid list resulting from a search.
AntimatroidSearchResultsRecord	getAntimatroidSearchResultsRecord(Type antimatroidSearchRecordType)	Gets the antimatroid search results record corresponding to the given antimatroid 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

getAntimatroids

AntimatroidList getAntimatroids()

Gets the antimatroid list resulting from a search.

Returns:

the antimatroid list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getAntimatroidQueryInspector

AntimatroidQueryInspector getAntimatroidQueryInspector()

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

Returns:

the antimatroid query inspector

Compliance:

mandatory - This method must be implemented.

getAntimatroidSearchResultsRecord

AntimatroidSearchResultsRecord getAntimatroidSearchResultsRecord(Type antimatroidSearchRecordType)
                                                          throws OperationFailedException

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

Parameters:

antimatroidSearchRecordType - an antimatroid search record type

Returns:

the antimatroid search results record

Throws:

NullArgumentException - antimatroidSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(antimatroidSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.