Interface ScheduleSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ScheduleSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ScheduleQueryInspector	getScheduleQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ScheduleList	getSchedules()	Gets the schedule list resulting from the search.
ScheduleSearchResultsRecord	getScheduleSearchResultsRecord(Type scheduleSearchRecordType)	Gets the schedule search results record corresponding to the given schedule 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

getSchedules

ScheduleList getSchedules()

Gets the schedule list resulting from the search.

Returns:

the schedule list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getScheduleQueryInspector

ScheduleQueryInspector getScheduleQueryInspector()

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.

getScheduleSearchResultsRecord

ScheduleSearchResultsRecord getScheduleSearchResultsRecord(Type scheduleSearchRecordType)
                                                    throws OperationFailedException

Gets the schedule search results record corresponding to the given schedule search record Type .

Parameters:

scheduleSearchRecordType - a schedule search record type

Returns:

the schedule search results record

Throws:

NullArgumentException - scheduleSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(scheduleSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.