Interface AppointmentSearchSession

All Superinterfaces:

AppointmentQuerySession, AutoCloseable, Closeable, OsidSession, 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 an 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

Modifier and Type	Method	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 AppointmentQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchAppointments()	Tests if this user can perform Appointment searches.
AppointmentQuery	getAppointmentQuery()	Gets an appointment query.
AppointmentList	getAppointmentsByQuery(AppointmentQuery appointmentQuery)	Gets a list of appointments matching the given appointment query.
Realm	getRealm()	Gets the Realm associated with this session.
Id	getRealmId()	Gets the Realm Id associated with this session.
void	useFederatedRealmView()	Federates the view for methods in this session.
void	useIsolatedRealmView()	Isolates the view for methods in this session.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.