org.osid.personnel

Interface AppointmentSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AppointmentSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
AppointmentQueryInspector	getAppointmentQueryInspector() Gets the inspector for the query to examine the terms used in the search.
AppointmentList	getAppointments() Gets the appointment list resulting from a search.
AppointmentSearchResultsRecord	getAppointmentSearchResultsRecord(Type appointmentSearchRecordType) Gets the record corresponding to the given appointment 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

getAppointments

AppointmentList getAppointments()

Gets the appointment list resulting from a search.

Returns:

the appointment list

Throws:

IllegalStateException - the list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAppointmentQueryInspector

AppointmentQueryInspector getAppointmentQueryInspector()

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.

getAppointmentSearchResultsRecord

AppointmentSearchResultsRecord getAppointmentSearchResultsRecord(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 results record

Throws:

NullArgumentException - appointmentSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(appointmentSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.