Interface ScheduleSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ScheduleSearch
extends OsidSearch

ScheduleSearch defines the interface for specifying schedule search options.

Method Summary

Modifier and Type	Method	Description
ScheduleSearchRecord	getScheduleSearchRecord(Type scheduleSearchRecordType)	Gets the schedule search record corresponding to the given schedule search record Type .
void	orderScheduleResults(ScheduleSearchOrder scheduleSearchOrder)	Specify an ordering to the search results.
void	searchAmongSchedules(IdList scheduleIds)	Execute this search among the given list of schedules.

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

searchAmongSchedules

void searchAmongSchedules(IdList scheduleIds)

Execute this search among the given list of schedules.

Parameters:

scheduleIds - list of schedules

Throws:

NullArgumentException - scheduleIds is null

Compliance:

mandatory - This method must be implemented.

orderScheduleResults

void orderScheduleResults(ScheduleSearchOrder scheduleSearchOrder)

Specify an ordering to the search results.

Parameters:

scheduleSearchOrder - schedule search order

Throws:

NullArgumentException - scheduleSearchOrder is null

UnsupportedException - scheduleSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getScheduleSearchRecord

ScheduleSearchRecord getScheduleSearchRecord(Type scheduleSearchRecordType)
                                      throws OperationFailedException

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

Parameters:

scheduleSearchRecordType - a schedule search record type

Returns:

the schedule search record

Throws:

NullArgumentException - scheduleSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(scheduleSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.