Interface ScheduleSlotSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ScheduleSlotSearch
extends OsidSearch

ScheduleSlotSearch defines the interface for specifying schedule slot search options.

Method Summary

Modifier and Type	Method	Description
ScheduleSlotSearchRecord	getScheduleSlotSearchRecord(Type scheduleSlotSearchRecordType)	Gets the schedule slot search record corresponding to the given schedule slot search record Type .
void	orderScheduleSlotResults(ScheduleSlotSearchOrder scheduleSlotSearchOrder)	Specify an ordering to the search results.
void	searchAmongScheduleSlots(IdList scheduleSlotIds)	Execute this search among the given list of schedule slots.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongScheduleSlots

void searchAmongScheduleSlots(IdList scheduleSlotIds)

Execute this search among the given list of schedule slots.

Parameters:

scheduleSlotIds - list of schedule slots

Throws:

NullArgumentException - scheduleSlotIds is null

Compliance:

mandatory - This method must be implemented.

orderScheduleSlotResults

void orderScheduleSlotResults(ScheduleSlotSearchOrder scheduleSlotSearchOrder)

Specify an ordering to the search results.

Parameters:

scheduleSlotSearchOrder - schedule slot search order

Throws:

NullArgumentException - scheduleSlotSearchOrder is null

UnsupportedException - scheduleSlotSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getScheduleSlotSearchRecord

ScheduleSlotSearchRecord getScheduleSlotSearchRecord(Type scheduleSlotSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

scheduleSlotSearchRecordType - a schedule slot search record type

Returns:

the schedule slot search record

Throws:

NullArgumentException - scheduleSlotSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(scheduleSlotSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.