org.osid.calendaring

Interface TimePeriodSearchSession

All Superinterfaces:

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

public interface TimePeriodSearchSession
extends TimePeriodQuerySession

This session provides methods for searching TimePeriod objects. The search query is constructed using the TimePeriodQuery. The time period record Type also specifies the record for the time period query.

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

Time periods may have a query record indicated by their respective record types. The query record is accessed via the TimePeriodQuery.

Method Summary

Methods

Modifier and Type	Method and Description
TimePeriodQuery	getTimePeriodQueryFromInspector(TimePeriodQueryInspector timePeriodQueryInspector) Gets a time period query from an inspector.
TimePeriodSearchResults	getTimePeriodsBySearch(TimePeriodQuery timePeriodQuery, TimePeriodSearch timePeriodSearch) Gets the search results matching the given search query using the given search.
TimePeriodSearch	getTimePeriodSearch() Gets a time period search.
TimePeriodSearchOrder	getTimePeriodSearchOrder() Gets a time period search order.

Methods inherited from interface org.osid.calendaring.TimePeriodQuerySession

canSearchTimePeriods, getCalendar, getCalendarId, getTimePeriodQuery, getTimePeriodsByQuery, 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

getTimePeriodSearch

TimePeriodSearch getTimePeriodSearch()

Gets a time period search.

Returns:

the time period search

Compliance:

mandatory - This method must be implemented.

getTimePeriodSearchOrder

TimePeriodSearchOrder getTimePeriodSearchOrder()

Gets a time period search order. The TimePeriodSearchOrder is supplied to a TimePeriodSearch to specify the ordering of results.

Returns:

the time period search order

Compliance:

mandatory - This method must be implemented.

getTimePeriodsBySearch

TimePeriodSearchResults getTimePeriodsBySearch(TimePeriodQuery timePeriodQuery,
                                             TimePeriodSearch timePeriodSearch)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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

Parameters:

timePeriodQuery - the time period query

timePeriodSearch - the time period search

Returns:

the time period search results

Throws:

NullArgumentException - timePeriodQuery or timePeriodSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - timePeriodSearch or t imePeriodQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getTimePeriodQueryFromInspector

TimePeriodQuery getTimePeriodQueryFromInspector(TimePeriodQueryInspector timePeriodQueryInspector)

Gets a time period query from an inspector. The inspector is available from a TimePeriodSearchResults.

Parameters:

timePeriodQueryInspector - a time period query inspector

Returns:

the time period query

Throws:

NullArgumentException - timePeriodQueryInspector is null

UnsupportedException - timePeriodQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.