Interface BudgetSearchSession

All Superinterfaces:

AutoCloseable, BudgetQuerySession, Closeable, OsidSession, OsidSession

public interface BudgetSearchSession
extends BudgetQuerySession

This session provides methods for searching among Budgets . The search query is constructed using the BudgetQuery .

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

This session defines views that offer differing behaviors for searching.

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

Budgets may have a query record indicated by their respective record types. The queryrecord is accessed via the BudgetQuery .

Method Summary

Modifier and Type	Method	Description
BudgetQuery	getBudgetQueryFromInspector(ItemQueryInspector budgetQueryInspector)	Gets a budget query from an inspector.
BudgetSearchResults	getBudgetsBySearch(BudgetQuery budgetQuery, BudgetSearch budgetSearch)	Gets the search results matching the given search query using the given search.
BudgetSearch	getBudgetSearch()	Gets a budget search.
BudgetSearchOrder	getBudgetSearchOrder()	Gets a budget search order.

Methods inherited from interface BudgetQuerySession

canSearchBudgets, getBudgetQuery, getBudgetsByQuery, getBusiness, getBusinessId, useFederatedBusinessView, useIsolatedBusinessView

Modifier and Type	Method	Description
boolean	canSearchBudgets()	Tests if this user can perform Budget lookups.
BudgetQuery	getBudgetQuery()	Gets a budget query.
BudgetList	getBudgetsByQuery(BudgetQuery budgetQuery)	Gets a list of Budgets matching the given budget query.
Business	getBusiness()	Gets the Business associated with this session.
Id	getBusinessId()	Gets the Business Id associated with this session.
void	useFederatedBusinessView()	Federates the view for methods in this session.
void	useIsolatedBusinessView()	Isolates the view for methods in this session.

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.

Method Details

getBudgetSearch

BudgetSearch getBudgetSearch()

Gets a budget search.

Returns:

the budget search

Compliance:

mandatory - This method must be implemented.

getBudgetSearchOrder

BudgetSearchOrder getBudgetSearchOrder()

Gets a budget search order. The BudgetSearchOrder is supplied to a BudgetSearch to specify the ordering of results.

Returns:

the budget search order

Compliance:

mandatory - This method must be implemented.

getBudgetsBySearch

BudgetSearchResults getBudgetsBySearch(BudgetQuery budgetQuery,
 BudgetSearch budgetSearch)
                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

budgetQuery - the budget query

budgetSearch - the budget search

Returns:

the budget search results

Throws:

NullArgumentException - budgetQuery or budgetSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - budgetQuery or budgetSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getBudgetQueryFromInspector

BudgetQuery getBudgetQueryFromInspector(ItemQueryInspector budgetQueryInspector)

Gets a budget query from an inspector. The inspector is available from a BudgetSearchResults .

Parameters:

budgetQueryInspector - a budget query inspector

Returns:

the budget query

Throws:

NullArgumentException - budgetQueryInspector is null

UnsupportedException - budgetQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.