public interface BudgetEntrySmartBusinessSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An BudgetEntryQuery
can be retrieved from this
session and mapped to this Business
to create a virtual
collection of BudgetEntries.
The budget entries may be
sequenced using the BudgetEntrySearchOrder
from this
session.
This Business
has a default query that matches any
budget entry and a default search order that specifies no sequencing. The
queries may be examined using an BudgetEntryQueryInspector.
The query may be modified by converting the inspector back to an
BudgetEntryQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyBudgetEntryQuery(BudgetEntryQuery budgetEntryQuery)
Applies a budget entry query to this business.
|
void |
applyBudgetEntrySequencing(BudgetEntrySearchOrder budgetEntrySearchOrder)
Applies a budget entry search order to this business.
|
boolean |
canManageSmartBusinesses()
Tests if this user can manage smart businesses.
|
BudgetEntryQuery |
getBudgetEntryQuery()
Gets a budget entry query.
|
BudgetEntryQuery |
getBudgetEntryQueryFromInspector(BudgetEntryQueryInspector budgetEntryQueryInspector)
Gets a budget entry query from an inspector.
|
BudgetEntrySearchOrder |
getBudgetEntrySearchOrder()
Gets a budget entry search order.
|
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
BudgetEntryQueryInspector |
inspectBudgetEntryQuery()
Gets a budget entry query inspector for this business.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBusinessId()
Business
Id
associated with
this session. Business Id
associated with this sessionmandatory
- This method must be implemented. Business getBusiness() throws OperationFailedException, PermissionDeniedException
Business
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartBusinesses()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart business management is not
authorized, true
otherwisemandatory
- This method must be implemented. BudgetEntryQuery getBudgetEntryQuery()
mandatory
- This method must be implemented. BudgetEntrySearchOrder getBudgetEntrySearchOrder()
mandatory
- This method must be implemented. void applyBudgetEntryQuery(BudgetEntryQuery budgetEntryQuery) throws OperationFailedException, PermissionDeniedException
budgetEntryQuery
- the budget entry queryNullArgumentException
- budgetEntryQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- budgetEntryQuery
not of this servicemandatory
- This method must be implemented. BudgetEntryQueryInspector inspectBudgetEntryQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyBudgetEntrySequencing(BudgetEntrySearchOrder budgetEntrySearchOrder) throws OperationFailedException, PermissionDeniedException
budgetEntrySearchOrder
- the budget entry search orderNullArgumentException
- budgetEntrySearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- budgetEntrySearchOrder
not of this servicemandatory
- This method must be implemented. BudgetEntryQuery getBudgetEntryQueryFromInspector(BudgetEntryQueryInspector budgetEntryQueryInspector)
budgetEntryQueryInspector
- a query inspectorNullArgumentException
-
budgetEntryQueryInspector
is null
UnsupportedException
- budgetEntryQueryInspector
is not of this servicemandatory
- This method must be implemented.