Interface CatalogSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CatalogSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
CatalogQueryInspector	getCatalogQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
CatalogList	getCatalogs()	Gets the catalog list resulting from the search.
CatalogSearchResultsRecord	getCatalogSearchResultsRecord(Type catalogSearchRecordType)	Gets the catalog search results record corresponding to the given catalog 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

getCatalogs

CatalogList getCatalogs()

Gets the catalog list resulting from the search.

Returns:

the catalogs list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCatalogQueryInspector

CatalogQueryInspector getCatalogQueryInspector()

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

Returns:

the catalog query inspector

Compliance:

mandatory - This method must be implemented.

getCatalogSearchResultsRecord

CatalogSearchResultsRecord getCatalogSearchResultsRecord(Type catalogSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

catalogSearchRecordType - a catalog search record type

Returns:

the catalog search results record

Throws:

NullArgumentException - catalogSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(catalogSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.