org.osid.calendaring

Interface ScheduleSlotSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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 a 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

Methods

Modifier and Type	Method and 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 org.osid.calendaring.ScheduleSlotQuerySession

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

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

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.