Interface DepotSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface DepotSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
DepotQueryInspector	getDepotQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
DepotList	getDepots()	Gets the depot list resulting from the search.
DepotSearchResultsRecord	getDepotSearchResultsRecord(Type depotSearchRecordType)	Gets the depot search results record corresponding to the given depot 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

getDepots

DepotList getDepots()

Gets the depot list resulting from the search.

Returns:

the depot list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getDepotQueryInspector

DepotQueryInspector getDepotQueryInspector()

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

Returns:

the depot query inspector

Compliance:

mandatory - This method must be implemented.

getDepotSearchResultsRecord

DepotSearchResultsRecord getDepotSearchResultsRecord(Type depotSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

depotSearchRecordType - a depot search record type

Returns:

the depot search results record

Throws:

NullArgumentException - depotSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(depotSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.