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

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

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.