Interface TimePeriodSearchSession

All Superinterfaces:

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

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

canSearchTimePeriods, getCalendar, getCalendarId, getTimePeriodQuery, getTimePeriodsByQuery, useFederatedCalendarView, useIsolatedCalendarView

Modifier and Type	Method	Description
boolean	canSearchTimePeriods()	Tests if this user can perform TimePeriod searches.
Calendar	getCalendar()	Gets the Calendar associated with this session.
Id	getCalendarId()	Gets the Calendar Id associated with this session.
TimePeriodQuery	getTimePeriodQuery()	Gets a time period query.
TimePeriodList	getTimePeriodsByQuery(TimePeriodQuery timePeriodQuery)	Gets a list of TimePeriods matching the given query.
void	useFederatedCalendarView()	Federates the view for methods in this session.
void	useIsolatedCalendarView()	Isolates the view for methods in this session.

Method Details

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.