org.osid.calendaring

Interface ScheduleSearchSession

All Superinterfaces:

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

public interface ScheduleSearchSession
extends ScheduleQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

Schedules may have a query record indicated by their respective record types. The query record is accessed via the ScheduleQuery.

Method Summary

Methods

Modifier and Type	Method and Description
ScheduleQuery	getScheduleQueryFromInspector(ScheduleQueryInspector scheduleQueryInspector) Gets a schedule query from an inspector.
ScheduleSearchResults	getSchedulesBySearch(ScheduleQuery scheduleQuery, ScheduleSearch scheduleSearch) Gets the search results matching the given search query using the given search.
ScheduleSearch	getScheduleSearch() Gets a schedule search.
ScheduleSearchOrder	getScheduleSearchOrder() Gets a schedule search order.

Methods inherited from interface org.osid.calendaring.ScheduleQuerySession

canSearchSchedules, getCalendar, getCalendarId, getScheduleQuery, getSchedulesByQuery, useFederatedCalendarView, useIsolatedCalendarView

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

getScheduleSearch

ScheduleSearch getScheduleSearch()

Gets a schedule search.

Returns:

the schedule search

Compliance:

mandatory - This method must be implemented.

getScheduleSearchOrder

ScheduleSearchOrder getScheduleSearchOrder()

Gets a schedule search order. The ScheduleSearchOrder is supplied to a ScheduleSearch to specify the ordering of results.

Returns:

the schedule search order

Compliance:

mandatory - This method must be implemented.

getSchedulesBySearch

ScheduleSearchResults getSchedulesBySearch(ScheduleQuery scheduleQuery,
                                         ScheduleSearch scheduleSearch)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

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

Parameters:

scheduleQuery - the schedule query

scheduleSearch - the schedule search

Returns:

the schedule search results

Throws:

NullArgumentException - scheduleQuery or scheduleSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - scheduleSearch or scheduleQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getScheduleQueryFromInspector

ScheduleQuery getScheduleQueryFromInspector(ScheduleQueryInspector scheduleQueryInspector)

Gets a schedule query from an inspector. The inspector is available from an ScheduleSearchResults.

Parameters:

scheduleQueryInspector - a schedule query inspector

Returns:

the schedule query

Throws:

NullArgumentException - scheduleQueryInspector is null

UnsupportedException - scheduleQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.