org.osid.course.chronicle

Interface AwardEntrySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AwardEntrySearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
AwardEntryList	getAwardEntries() Gets the course list resulting from a search.
AwardEntryQueryInspector	getAwardEntryQueryInspector() Gets the inspector for the query to examine the terms used in the search.
AwardEntrySearchResultsRecord	getAwardEntrySearchResultsRecord(Type awardEntrySearchRecordType) Gets the award entry search results record corresponding to the given award entry 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

getAwardEntries

AwardEntryList getAwardEntries()

Gets the course list resulting from a search.

Returns:

the award entry list

Throws:

IllegalStateException - the award entry list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAwardEntryQueryInspector

AwardEntryQueryInspector getAwardEntryQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getAwardEntrySearchResultsRecord

AwardEntrySearchResultsRecord getAwardEntrySearchResultsRecord(Type awardEntrySearchRecordType)
                                                               throws OperationFailedException

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

Parameters:

awardEntrySearchRecordType - an award entry search record type

Returns:

the award entry search results record

Throws:

NullArgumentException - awardEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(awardEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.