org.osid.offering

Interface CatalogueSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CatalogueSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
CatalogueQueryInspector	getCatalogueQueryInspector() Gets the inspector for the query to examine the terms used in the search.
CatalogueList	getCatalogues() Gets the catalogue list resulting from a search.
CatalogueSearchResultsRecord	getCatalogueSearchResultsRecord(Type catalogueSearchRecordType) Gets the record corresponding to the given catalogue 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

getCatalogues

CatalogueList getCatalogues()

Gets the catalogue list resulting from a search.

Returns:

the catalogue list

Throws:

IllegalStateException - the list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCatalogueQueryInspector

CatalogueQueryInspector getCatalogueQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getCatalogueSearchResultsRecord

CatalogueSearchResultsRecord getCatalogueSearchResultsRecord(Type catalogueSearchRecordType)
                                                             throws OperationFailedException

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

Parameters:

catalogueSearchRecordType - a catalogue search record type

Returns:

the catalogue search results record

Throws:

NullArgumentException - catalogueSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(catalogueSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.