org.osid.financials.budgeting

Interface BudgetSearchSession

All Superinterfaces:

java.lang.AutoCloseable, BudgetQuerySession, java.io.Closeable, OsidSession

public interface BudgetSearchSession
extends BudgetQuerySession

This session provides methods for searching among Budget objects. 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

Methods

Modifier and Type	Method and 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 org.osid.financials.budgeting.BudgetQuerySession

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

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.