Interface FiscalPeriodSearchSession

All Superinterfaces:

AutoCloseable, Closeable, FiscalPeriodQuerySession, OsidSession, OsidSession

public interface FiscalPeriodSearchSession
extends FiscalPeriodQuerySession

This session provides methods for searching among FiscalPeriods . The search query is constructed using the FiscalPeriodQuery .

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
FiscalPeriodQuery	getFiscalPeriodQueryFromInspector(ItemQueryInspector fiscalPeriodQueryInspector)	Gets a fiscal period query from an inspector.
FiscalPeriodSearchResults	getFiscalPeriodsBySearch(FiscalPeriodQuery fiscalPeriodQuery, FiscalPeriodSearch fiscalPeriodSearch)	Gets the search results matching the given search query using the given search.
FiscalPeriodSearch	getFiscalPeriodSearch()	Gets a fiscal period search.
FiscalPeriodSearchOrder	getFiscalPeriodSearchOrder()	Gets a fiscal period search order.

Methods inherited from interface Closeable

close

Methods inherited from interface FiscalPeriodQuerySession

canSearchFiscalPeriods, getBusiness, getBusinessId, getFiscalPeriodQuery, getFiscalPeriodsByQuery, useFederatedBusinessView, useIsolatedBusinessView

Modifier and Type	Method	Description
boolean	canSearchFiscalPeriods()	Tests if this user can perform FiscalPeriod lookups.
Business	getBusiness()	Gets the Business associated with this session.
Id	getBusinessId()	Gets the Business Id associated with this session.
FiscalPeriodQuery	getFiscalPeriodQuery()	Gets a fiscal period query.
FiscalPeriodList	getFiscalPeriodsByQuery(FiscalPeriodQuery fiscalPeriodQuery)	Gets a list of FiscalPeriods matching the given fiscal period query.
void	useFederatedBusinessView()	Federates the view for methods in this session.
void	useIsolatedBusinessView()	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

getFiscalPeriodSearch

FiscalPeriodSearch getFiscalPeriodSearch()

Gets a fiscal period search.

Returns:

the fiscal period search

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodSearchOrder

FiscalPeriodSearchOrder getFiscalPeriodSearchOrder()

Gets a fiscal period search order. The FiscalPeriodSearchOrder is supplied to a FiscalPeriodSearch to specify the ordering of results.

Returns:

the fiscal period search order

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodsBySearch

FiscalPeriodSearchResults getFiscalPeriodsBySearch(FiscalPeriodQuery fiscalPeriodQuery,
 FiscalPeriodSearch fiscalPeriodSearch)
                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

fiscalPeriodQuery - the fiscal period query

fiscalPeriodSearch - the fiscal period search

Returns:

the fiscal period search results

Throws:

NullArgumentException - fiscalPeriodQuery or fiscalPeriodSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - fiscalPeriodQuery or fiscalPeriodSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodQueryFromInspector

FiscalPeriodQuery getFiscalPeriodQueryFromInspector(ItemQueryInspector fiscalPeriodQueryInspector)

Gets a fiscal period query from an inspector. The inspector is available from a FiscalPeriodSearchResults .

Parameters:

fiscalPeriodQueryInspector - a fiscal period query inspector

Returns:

the fiscal period query

Throws:

NullArgumentException - fiscalPeriodQueryInspector is null

UnsupportedException - fiscalPeriodQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.