Interface ScheduleSearchSession

All Superinterfaces:

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

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

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

Modifier and Type	Method	Description
boolean	canSearchSchedules()	Tests if this user can perform Schedules searches.
Calendar	getCalendar()	Gets the Calendar associated with this session.
Id	getCalendarId()	Gets the Calendar Id associated with this session.
ScheduleQuery	getScheduleQuery()	Gets a schedule query.
ScheduleList	getSchedulesByQuery(ScheduleQuery scheduleQuery)	Gets a list of Schedules matching the given schedle query.
void	useFederatedCalendarView()	Federates the view for methods in this session.
void	useIsolatedCalendarView()	Isolates the view for methods in this session.

Method Details

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.