Interface PeriodSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, PeriodQuerySession

public interface PeriodSearchSession
extends PeriodQuerySession

This session provides methods for searching among Periods . The search query is constructed using the PeriodQuery .

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

This session defines views that offer differing behaviors for searching.

• federated business view: searches include periods in businesses of which this business is an ancestor in the business hierarchy
• isolated business view: searches are restricted to periods in this business

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

Method Summary

Modifier and Type	Method	Description
PeriodQuery	getPeriodQueryFromInspector(PeriodQueryInspector periodQueryInspector)	Gets a period query from an inspector.
PeriodSearchResults	getPeriodsBySearch(PeriodQuery periodQuery, PeriodSearch periodSearch)	Gets the search results matching the given search query using the given search.
PeriodSearch	getPeriodSearch()	Gets a period search.
PeriodSearchOrder	getPeriodSearchOrder()	Gets a 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 PeriodQuerySession

canSearchPeriods, getBusiness, getBusinessId, getPeriodQuery, getPeriodsByQuery, useFederatedBusinessView, useIsolatedBusinessView

Modifier and Type	Method	Description
boolean	canSearchPeriods()	Tests if this user can perform Period lookups.
Business	getBusiness()	Gets the Business associated with this session.
Id	getBusinessId()	Gets the Business Id associated with this session.
PeriodQuery	getPeriodQuery()	Gets a period query.
PeriodList	getPeriodsByQuery(PeriodQuery periodQuery)	Gets a list of Periods matching the given period query.
void	useFederatedBusinessView()	Federates the view for methods in this session.
void	useIsolatedBusinessView()	Isolates the view for methods in this session.

Method Details

getPeriodSearch

PeriodSearch getPeriodSearch()

Gets a period search.

Returns:

the period search

Compliance:

mandatory - This method must be implemented.

getPeriodSearchOrder

PeriodSearchOrder getPeriodSearchOrder()

Gets a period search order. The PeriodSearchOrder is supplied to a PeriodSearch to specify the ordering of results.

Returns:

the period search order

Compliance:

mandatory - This method must be implemented.

getPeriodsBySearch

PeriodSearchResults getPeriodsBySearch(PeriodQuery periodQuery,
 PeriodSearch periodSearch)
                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

periodQuery - the period query

periodSearch - the period search

Returns:

the period search results

Throws:

NullArgumentException - periodQuery or periodSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - periodQuery or periodSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPeriodQueryFromInspector

PeriodQuery getPeriodQueryFromInspector(PeriodQueryInspector periodQueryInspector)

Gets a period query from an inspector. The inspector is available from a PeriodSearchResults .

Parameters:

periodQueryInspector - a period query inspector

Returns:

the period query

Throws:

NullArgumentException - periodQueryInspector is null

UnsupportedException - periodQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.