org.osid.recognition

Interface AwardSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AwardSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
AwardQueryInspector	getAwardQueryInspector() Gets the inspector for the query to examine the terns used in the search.
AwardList	getAwards() Gets the award list resulting from a search.
AwardSearchResultsRecord	getAwardSearchResultsRecord(Type awardSearchRecordType) Gets the award search results record corresponding to the given award 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

getAwards

AwardList getAwards()

Gets the award list resulting from a search.

Returns:

the award list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAwardQueryInspector

AwardQueryInspector getAwardQueryInspector()

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.

getAwardSearchResultsRecord

AwardSearchResultsRecord getAwardSearchResultsRecord(Type awardSearchRecordType)
                                                     throws OperationFailedException

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

Parameters:

awardSearchRecordType - an award search record type

Returns:

the award search results record

Throws:

NullArgumentException - AwardSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(awardSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.