org.osid.personnel

Interface AppointmentSearchSession

All Superinterfaces:

AppointmentQuerySession, java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AppointmentSearchSession
extends AppointmentQuerySession

This session provides methods for searching Appointment objects. The search query is constructed using the AppointmentQuery. The appointment record Type also specifies the record for the appointment query.

getAppointmentsByQuery() is the basic search method and returns a list of Appointment elements. A more advanced search may be performed with getAppointmentsBySearch(). It accepts an AppointmentSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAppointmentsBySearch() returns an AppointmentSearchResults that can be used to access the resulting AppointmentList or be used to perform a search within the result set through AppointmentSearch.

This session defines views that offer differing behaviors for searching.

• federated realm view: searches include appointments in realms of which this realm is a ancestor in the realm hierarchy
• isolated realm view: searches are restricted to appointments in this realm

Appointments may have a query record indicated by their respective record types. The query record is accessed via the AppointmentQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Methods

Modifier and Type	Method and Description
AppointmentQuery	getAppointmentQueryFromInspector(AppointmentQueryInspector appointmentQueryInspector) Gets an appointment query from an inspector.
AppointmentSearchResults	getAppointmentsBySearch(AppointmentQuery appointmentQuery, AppointmentSearch appointmentSearch) Gets the search results matching the given search.
AppointmentSearch	getAppointmentSearch() Gets an appointment search.
AppointmentSearchOrder	getAppointmentSearchOrder() Gets an appointment search order.

Methods inherited from interface org.osid.personnel.AppointmentQuerySession

canSearchAppointments, getAppointmentQuery, getAppointmentsByQuery, getRealm, getRealmId, useFederatedRealmView, useIsolatedRealmView

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getAppointmentSearch

AppointmentSearch getAppointmentSearch()

Gets an appointment search.

Returns:

the appointment search

Compliance:

mandatory - This method must be implemented.

getAppointmentSearchOrder

AppointmentSearchOrder getAppointmentSearchOrder()

Gets an appointment search order. The AppointmentSearchOrder is supplied to an AppointmentSearch to specify the ordering of results.

Returns:

the appointment search order

Compliance:

mandatory - This method must be implemented.

getAppointmentsBySearch

AppointmentSearchResults getAppointmentsBySearch(AppointmentQuery appointmentQuery,
                                               AppointmentSearch appointmentSearch)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Gets the search results matching the given search.

Parameters:

appointmentQuery - the appointment query

appointmentSearch - the appointment search

Returns:

the search results

Throws:

NullArgumentException - appointmentQuery or appointmentSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - appointmentQuery or appointmentSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAppointmentQueryFromInspector

AppointmentQuery getAppointmentQueryFromInspector(AppointmentQueryInspector appointmentQueryInspector)

Gets an appointment query from an inspector. The inspector is available from an AppointmentSearchResults.

Parameters:

appointmentQueryInspector - an appointment query inspector

Returns:

the appointment query

Throws:

NullArgumentException - appointmentQueryInspector is null

UnsupportedException - appointmentQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.