Interface ScheduleSlotSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, ScheduleSlotQuerySession

public interface ScheduleSlotSearchSession
extends ScheduleSlotQuerySession

This session provides methods for searching ScheduleSlot objects. The search query is constructed using the ScheduleSlotQuery . The schedule slot record Type also specifies the record for the schedule slot query.

getScheduleSlotsByQuery() is the basic search method and returns a list of ScheduleSlots . A more advanced search may be performed with getScheduleSlotsBySearch() .It accepts a ScheduleSlotSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getScheduleSlotsBySearch() returns a ScheduleSlotSearchResults that can be used to access the resulting ScheduleSlotsList or be used to perform a search within the result set through ScheduleSlotSearch .

This session defines views that offer differing behaviors for searching.

• federated calendar view: searches include schedule slots in calendars of which this calendar is an ancestor in the calendar hierarchy
• isolated calendar view: searches are restricted to schedule slots in this calendar

Schedule slots may have a query record indicated by their respective record types. The query record is accessed via the ScheduleSlotQuery .

Method Summary

Modifier and Type	Method	Description
ScheduleSlotQuery	getScheduleSlotQueryFromInspector(ScheduleSlotQueryInspector scheduleSlotQueryInspector)	Gets a schedule slot query from an inspector.
ScheduleSearchResults	getScheduleSlotsBySearch(ScheduleSlotQuery scheduleSlotQuery, ScheduleSlotSearch scheduleSlotSearch)	Gets the search results matching the given search query using the given search.
ScheduleSlotSearch	getScheduleSlotSearch()	Gets a schedule slot search.
ScheduleSlotSearchOrder	getScheduleSlotSearchOrder()	Gets a schedule slot search order.

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.

Methods inherited from interface ScheduleSlotQuerySession

canSearchScheduleSlots, getCalendar, getCalendarId, getScheduleSlotQuery, getScheduleSlotsByQuery, useFederatedCalendarView, useIsolatedCalendarView, useSequesteredScheduleSlotView, useUnsequesteredScheduleSlotView

Modifier and Type	Method	Description
boolean	canSearchScheduleSlots()	Tests if this user can perform ScheduleSlots searches.
Calendar	getCalendar()	Gets the Calendar associated with this session.
Id	getCalendarId()	Gets the Calendar Id associated with this session.
ScheduleSlotQuery	getScheduleSlotQuery()	Gets a schedule slot query.
ScheduleSlotList	getScheduleSlotsByQuery(ScheduleSlotQuery scheduleSlotQuery)	Gets a list of ScheduleSlots matching the given schedule slot query.
void	useFederatedCalendarView()	Federates the view for methods in this session.
void	useIsolatedCalendarView()	Isolates the view for methods in this session.
void	useSequesteredScheduleSlotView()	The returns from the search methods omit sequestered schedule slots.
void	useUnsequesteredScheduleSlotView()	All schedule slots are returned including sequestered schedule slots.

Method Details

getScheduleSlotSearch

ScheduleSlotSearch getScheduleSlotSearch()

Gets a schedule slot search.

Returns:

the schedule slot search

Compliance:

mandatory - This method must be implemented.

getScheduleSlotSearchOrder

ScheduleSlotSearchOrder getScheduleSlotSearchOrder()

Gets a schedule slot search order. The ScheduleSlotSearchOrder is supplied to a ScheduleSlotSearch to specify the ordering of results.

Returns:

the schedule slot search order

Compliance:

mandatory - This method must be implemented.

getScheduleSlotsBySearch

ScheduleSearchResults getScheduleSlotsBySearch(ScheduleSlotQuery scheduleSlotQuery,
 ScheduleSlotSearch scheduleSlotSearch)
                                        throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

scheduleSlotQuery - the schedule slot query

scheduleSlotSearch - the schedule slot search

Returns:

the schedule slot search results

Throws:

NullArgumentException - scheduleSlotQuery or scheduleSlotSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - scheduleSlotSearch or scheduleSlotQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getScheduleSlotQueryFromInspector

ScheduleSlotQuery getScheduleSlotQueryFromInspector(ScheduleSlotQueryInspector scheduleSlotQueryInspector)

Gets a schedule slot query from an inspector. The inspector is available from an ScheduleSlotSearchResults .

Parameters:

scheduleSlotQueryInspector - a schedule slot query inspector

Returns:

the schedule query

Throws:

NullArgumentException - scheduleSlotQueryInspector is null

UnsupportedException - scheduleSlotQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.