Interface OffsetEventSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OffsetEventQuerySession, OsidSession, OsidSession

public interface OffsetEventSearchSession
extends OffsetEventQuerySession

This session provides methods for searching OffsetEvent objects. The search query is constructed using the OffsetEventQuery . The offset event record Type also specifies the record for the offset event query.

getOffsetEventsByQuery() is the basic search method and returns a list of OffsetEvents . A more advanced search may be performed with getOffsetEventsBySearch() .It accepts an OffsetEventSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getOffsetEventsBySearch() returns an OffsetEventSearchResults that can be used to access the resulting OffsetEventList or be used to perform a search within the result set through OffsetEventSearch .

This session defines views that offer differing behaviors for searching.

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

Offset events may have a query record indicated by their respective record types. The query record is accessed via the OffsetEventQuery .

Method Summary

Modifier and Type	Method	Description
OffsetEventQuery	getOffsetEventQueryFromInspector(OffsetEventQueryInspector offsetEventQueryInspector)	Gets an offset event query from an inspector.
OffsetEventSearchResults	getOffsetEventsBySearch(OffsetEventQuery offsetEventQuery, OffsetEventSearch offsetEventSearch)	Gets the search results matching the given search query using the given search.
OffsetEventSearch	getOffsetEventSearch()	Gets an offset event search.
OffsetEventSearchOrder	getOffsetEventSearchOrder()	Gets an offset event search order.

Methods inherited from interface Closeable

close

Methods inherited from interface OffsetEventQuerySession

canSearchOffsetEvents, getCalendar, getCalendarId, getOffsetEventQuery, getOffsetEventsByQuery, useFederatedCalendarView, useIsolatedCalendarView

Modifier and Type	Method	Description
boolean	canSearchOffsetEvents()	Tests if this user can perform OffsetEvents searches.
Calendar	getCalendar()	Gets the Calendar associated with this session.
Id	getCalendarId()	Gets the Calendar Id associated with this session.
OffsetEventQuery	getOffsetEventQuery()	Gets an offset event query.
OffsetEventList	getOffsetEventsByQuery(OffsetEventQuery offsetEventQuery)	Gets a list of OffsetEvents matching the given offset event query.
void	useFederatedCalendarView()	Federates the view for methods in this session.
void	useIsolatedCalendarView()	Isolates the view for methods in this session.

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

getOffsetEventSearch

OffsetEventSearch getOffsetEventSearch()

Gets an offset event search.

Returns:

the offset event search

Compliance:

mandatory - This method must be implemented.

getOffsetEventSearchOrder

OffsetEventSearchOrder getOffsetEventSearchOrder()

Gets an offset event search order. The OffsetEventSearchOrder is supplied to an OffsetEventSearch to specify the ordering of results.

Returns:

the offset event search order

Compliance:

mandatory - This method must be implemented.

getOffsetEventsBySearch

OffsetEventSearchResults getOffsetEventsBySearch(OffsetEventQuery offsetEventQuery,
 OffsetEventSearch offsetEventSearch)
                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

offsetEventQuery - the offset event search query

offsetEventSearch - the offset event search

Returns:

the returned search results

Throws:

NullArgumentException - offsetEventQuery or offsetEventSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - offsetEventQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getOffsetEventQueryFromInspector

OffsetEventQuery getOffsetEventQueryFromInspector(OffsetEventQueryInspector offsetEventQueryInspector)

Gets an offset event query from an inspector. The inspector is available from an OffsetEventSearchResults .

Parameters:

offsetEventQueryInspector - an offset event query inspector

Returns:

the offset event query

Throws:

NullArgumentException - offsetEventQueryInspector is null

UnsupportedException - offsetEventQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.