Interface AcademySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AcademySearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
AcademyList	getAcademies()	Gets the academy list resulting from a search.
AcademyQueryInspector	getAcademyQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
AcademySearchResultsRecord	getAcademySearchResultsRecord(Type academySearchRecordType)	Gets the academy search rsults record corresponding to the given academy 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

getAcademies

AcademyList getAcademies()

Gets the academy list resulting from a search.

Returns:

the academy list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAcademyQueryInspector

AcademyQueryInspector getAcademyQueryInspector()

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.

getAcademySearchResultsRecord

AcademySearchResultsRecord getAcademySearchResultsRecord(Type academySearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

academySearchRecordType - an academy search record type

Returns:

the academy search results record

Throws:

NullArgumentException - academySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(academySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.