org.osid.resourcing

Interface FoundrySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface FoundrySearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
FoundryList	getFoundries() Gets the foundry list resulting from a search.
FoundryQueryInspector	getFoundryQueryInspector() Gets the inspector for the query to examine the terms used in the search.
FoundrySearchResultsRecord	getFoundrySearchResultsRecord(Type foundrySearchRecordType) Gets the foundry search results record corresponding to the given foundry 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

getFoundries

FoundryList getFoundries()

Gets the foundry list resulting from a search.

Returns:

the foundry list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getFoundryQueryInspector

FoundryQueryInspector getFoundryQueryInspector()

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

Returns:

the foundry query inspector

Compliance:

mandatory - This method must be implemented.

getFoundrySearchResultsRecord

FoundrySearchResultsRecord getFoundrySearchResultsRecord(Type foundrySearchRecordType)
                                                         throws OperationFailedException

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

Parameters:

foundrySearchRecordType - a foundry search record type

Returns:

the foundry search results record

Throws:

NullArgumentException - foundrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(foundrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.