Interface BudgetEntrySearchSession

All Superinterfaces:

AutoCloseable, BudgetEntryQuerySession, Closeable, OsidSession, OsidSession

public interface BudgetEntrySearchSession
extends BudgetEntryQuerySession

This session provides methods for searching among BudgetEntries . The search query is constructed using the BudgetEntryQuery .

getBudgetEntriesByQuery() is the basic search method and returns a list of BudgetEntrys . A more advanced search may be performed with getBudgetEntrysBySearch() .It accepts an BudgetEntrySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getBudgetEntriesBySearch() returns an BudgetEntrySearchResults that can be used to access the resulting BudgetEntryList or be used to perform a search within the result set through BudgetEntrySearch .

This session defines views that offer differing behaviors for searching.

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

BudgetBudget Entries may have a query record indicated by their respective record types. The query record is accessed via the BudgetEntryQuery .

Method Summary

Modifier and Type	Method	Description
BudgetEntrySearchResults	getBudgetEntriesBySearch(BudgetEntryQuery budgetEntryQuery, BudgetEntrySearch budgetEntrySearch)	Gets the search results matching the given search query using the given search.
BudgetEntryQuery	getBudgetEntryQueryFromInspector(BudgetEntryQueryInspector budgetEntryQueryInspector)	Gets a budget entry query from an inspector.
BudgetEntrySearch	getBudgetEntrySearch()	Gets a budget entry search.
BudgetEntrySearchOrder	getBudgetEntrySearchOrder()	Gets a budget entry search order.

Methods inherited from interface BudgetEntryQuerySession

canSearchBudgetEntries, getBudgetEntriesByQuery, getBudgetEntryQuery, getBusiness, getBusinessId, useFederatedBusinessView, useIsolatedBusinessView

Modifier and Type	Method	Description
boolean	canSearchBudgetEntries()	Tests if this user can perform BudgetEntry lookups.
BudgetEntryList	getBudgetEntriesByQuery(BudgetEntryQuery budgetEntryQuery)	Gets a list of BudgetEntries matching the given budget entry query.
BudgetEntryQuery	getBudgetEntryQuery()	Gets a budget entry 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

getBudgetEntrySearch

BudgetEntrySearch getBudgetEntrySearch()

Gets a budget entry search.

Returns:

the budget entry search

Compliance:

mandatory - This method must be implemented.

getBudgetEntrySearchOrder

BudgetEntrySearchOrder getBudgetEntrySearchOrder()

Gets a budget entry search order. The BudgetEntrySearchOrder is supplied to an BudgetEntrySearch to specify the ordering of results.

Returns:

the budget entry search order

Compliance:

mandatory - This method must be implemented.

getBudgetEntriesBySearch

BudgetEntrySearchResults getBudgetEntriesBySearch(BudgetEntryQuery budgetEntryQuery,
 BudgetEntrySearch budgetEntrySearch)
                                           throws OperationFailedException,
PermissionDeniedException

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

Parameters:

budgetEntryQuery - the budget entry query

budgetEntrySearch - the budget entry search

Returns:

the budget entry search results

Throws:

NullArgumentException - budgetEntryQuery or budgetEntrySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - budgetEntryQuery or budgetEntrySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getBudgetEntryQueryFromInspector

BudgetEntryQuery getBudgetEntryQueryFromInspector(BudgetEntryQueryInspector budgetEntryQueryInspector)

Gets a budget entry query from an inspector. The inspector is available from an BudgetEntrySearchResults .

Parameters:

budgetEntryQueryInspector - a budget entry query inspector

Returns:

the budget entry query

Throws:

NullArgumentException - budgetEntryQueryInspector is null

UnsupportedException - budgetEntryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.