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

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

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.