Interface SyllabusSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface SyllabusSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
SyllabusList	getSyllabi()	Gets the syllabus list resulting from a search.
SyllabusQueryInspector	getSyllabusQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
SyllabusSearchResultsRecord	getSyllabusSearchResultsRecord(Type syllabusSearchRecordType)	Gets the syllabus search results record corresponding to the given syllabus search record Type .This method is used to retrieve an object implementing the requested record.

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

getSyllabi

SyllabusList getSyllabi()

Gets the syllabus list resulting from a search.

Returns:

the syllabus list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getSyllabusQueryInspector

SyllabusQueryInspector getSyllabusQueryInspector()

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.

getSyllabusSearchResultsRecord

SyllabusSearchResultsRecord getSyllabusSearchResultsRecord(Type syllabusSearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

syllabusSearchRecordType - a syllabus search record type

Returns:

the syllabus search record

Throws:

NullArgumentException - syllabusSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(syllabusSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.