Interface BinSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BinSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
BinQueryInspector	getBinQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
BinList	getBins()	Gets the bin list resulting from the search.
BinSearchResultsRecord	getBinSearchResultsRecord(Type binSearchRecordType)	Gets the bin search results record corresponding to the given bin 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

getBins

BinList getBins()

Gets the bin list resulting from the search.

Returns:

the bin list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getBinQueryInspector

BinQueryInspector getBinQueryInspector()

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

Returns:

the bin query inspector

Compliance:

mandatory - This method must be implemented.

getBinSearchResultsRecord

BinSearchResultsRecord getBinSearchResultsRecord(Type binSearchRecordType)
                                          throws OperationFailedException

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

Parameters:

binSearchRecordType - a bin search record type

Returns:

the bin search results record

Throws:

NullArgumentException - binSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(binSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.