org.osid.financials.budgeting

Interface BudgetSmartBusinessSession

All Superinterfaces:

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

public interface BudgetSmartBusinessSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A BudgetQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of Budgets. The budgets may be sequenced using the BudgetSearchOrder from this session.

This Business has a default query that matches any budget and a default search order that specifies no sequencing. The queries may be examined using a BudgetQueryInspector. The query may be modified by converting the inspector back to a BudgetQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyBudgetQuery(BudgetQuery budgetQuery) Applies a budget query to this business.
void	applyBudgetSequencing(BudgetSearchOrder budgetSearchOrder) Applies a budget search order to this business.
boolean	canManageSmartBusinesses() Tests if this user can manage smart businesses.
BudgetQuery	getBudgetQuery() Gets a budget query.
BudgetQuery	getBudgetQueryFromInspector(BudgetQueryInspector budgetQueryInspector) Gets a budget query from an inspector.
BudgetSearchOrder	getBudgetSearchOrder() Gets a budget search order.
Business	getBusiness() Gets the Business associated with this session.
Id	getBusinessId() Gets the Business Id associated with this session.
BudgetQueryInspector	inspectBudgetQuery() Gets a budget query inspector for this business.

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

getBusinessId

Id getBusinessId()

Gets the Business Id associated with this session.

Returns:

the Business Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBusiness

Business getBusiness()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Business associated with this session.

Returns:

the business

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartBusinesses

boolean canManageSmartBusinesses()

Tests if this user can manage smart businesses. A return of true does not guarantee successful assessment. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returns:

false if smart business management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getBudgetQuery

BudgetQuery getBudgetQuery()

Gets a budget query.

Returns:

the budget query

Compliance:

mandatory - This method must be implemented.

getBudgetSearchOrder

BudgetSearchOrder getBudgetSearchOrder()

Gets a budget search order.

Returns:

the budget search order

Compliance:

mandatory - This method must be implemented.

applyBudgetQuery

void applyBudgetQuery(BudgetQuery budgetQuery)
                      throws OperationFailedException,
                             PermissionDeniedException

Applies a budget query to this business.

Parameters:

budgetQuery - the budget query

Throws:

NullArgumentException - budgetQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - budgetQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectBudgetQuery

BudgetQueryInspector inspectBudgetQuery()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets a budget query inspector for this business.

Returns:

the budget query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyBudgetSequencing

void applyBudgetSequencing(BudgetSearchOrder budgetSearchOrder)
                           throws OperationFailedException,
                                  PermissionDeniedException

Applies a budget search order to this business.

Parameters:

budgetSearchOrder - the budget search order

Throws:

NullArgumentException - budgetSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - budgetSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getBudgetQueryFromInspector

BudgetQuery getBudgetQueryFromInspector(BudgetQueryInspector budgetQueryInspector)

Gets a budget query from an inspector.

Parameters:

budgetQueryInspector - a 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.