org.osid.cataloging

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

Methods

Modifier and Type	Method and 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.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

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.