Interface AppointmentSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AppointmentSearch
extends OsidSearch

The search interface for governing appointment searches.

Method Summary

Modifier and Type	Method	Description
AppointmentSearchRecord	getAppointmentSearchRecord(Type appointmentSearchRecordType)	Gets the record corresponding to the given appointment search record Type .
void	orderAppointmentResults(AppointmentSearchOrder appointmentSearchOrder)	Specify an ordering to the search results.
void	searchAmongAppointments(IdList appointmentIds)	Execute this search among the given list of appointments.

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

searchAmongAppointments

void searchAmongAppointments(IdList appointmentIds)

Execute this search among the given list of appointments.

Parameters:

appointmentIds - list of appointments

Throws:

NullArgumentException - appointmentIds is null

Compliance:

mandatory - This method must be implemented.

orderAppointmentResults

void orderAppointmentResults(AppointmentSearchOrder appointmentSearchOrder)

Specify an ordering to the search results.

Parameters:

appointmentSearchOrder - appointment search order

Throws:

NullArgumentException - appointmentSearchOrder is null

UnsupportedException - appointmentSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAppointmentSearchRecord

AppointmentSearchRecord getAppointmentSearchRecord(Type appointmentSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

appointmentSearchRecordType - an appointment search record type

Returns:

the appointment search record

Throws:

NullArgumentException - appointmentSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(appointmentSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.