org.osid.recognition

Interface ConferralSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ConferralSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
ConferralQueryInspector	getConferralQueryInspector() Gets the inspector for the query to examine the terns used in the search.
ConferralList	getConferrals() Gets the conferral list resulting from a search.
ConferralSearchResultsRecord	getConferralSearchResultsRecord(Type conferralSearchRecordType) Gets the conferral search results record corresponding to the given conferral 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

getConferrals

ConferralList getConferrals()

Gets the conferral list resulting from a search.

Returns:

the conferral list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getConferralQueryInspector

ConferralQueryInspector getConferralQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getConferralSearchResultsRecord

ConferralSearchResultsRecord getConferralSearchResultsRecord(Type conferralSearchRecordType)
                                                             throws OperationFailedException

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

Parameters:

conferralSearchRecordType - a conferral search record type

Returns:

the conferral search record

Throws:

NullArgumentException - conferralSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(conferralSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.