org.osid.calendaring

Interface ScheduleSlotSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ScheduleSlotSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
ScheduleSlotQueryInspector	getScheduleSlotQueryInspector() Gets the inspector for the query to examine the terms used in the search.
ScheduleSlotList	getScheduleSlots() Gets the schedule list resulting from the search.
ScheduleSlotSearchResultsRecord	getScheduleSlotSearchResultsRecord(Type scheduleSlotSearchRecordType) Gets the schedule slot record corresponding to the given schedule slot 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

getScheduleSlots

ScheduleSlotList getScheduleSlots()

Gets the schedule list resulting from the search.

Returns:

the schedule slot list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getScheduleSlotQueryInspector

ScheduleSlotQueryInspector getScheduleSlotQueryInspector()

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.

getScheduleSlotSearchResultsRecord

ScheduleSlotSearchResultsRecord getScheduleSlotSearchResultsRecord(Type scheduleSlotSearchRecordType)
                                                                   throws OperationFailedException

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

Parameters:

scheduleSlotSearchRecordType - a schedule slot search record type

Returns:

the schedule slot search results record

Throws:

NullArgumentException - scheduleSlotSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(scheduleSlotSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.