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.
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.
|
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. BudgetQuery getBudgetQuery()
mandatory
- This method must be implemented. BudgetSearchOrder getBudgetSearchOrder()
mandatory
- This method must be implemented. void applyBudgetQuery(BudgetQuery budgetQuery) throws OperationFailedException, PermissionDeniedException
budgetQuery
- the budget queryNullArgumentException
- budgetQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- budgetQuery
not
of this servicemandatory
- This method must be implemented. BudgetQueryInspector inspectBudgetQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyBudgetSequencing(BudgetSearchOrder budgetSearchOrder) throws OperationFailedException, PermissionDeniedException
budgetSearchOrder
- the budget search orderNullArgumentException
- budgetSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- budgetSearchOrder
not of this servicemandatory
- This method must be implemented. BudgetQuery getBudgetQueryFromInspector(BudgetQueryInspector budgetQueryInspector)
budgetQueryInspector
- a query inspectorNullArgumentException
- budgetQueryInspector
is null
UnsupportedException
- budgetQueryInspector
is not of this servicemandatory
- This method must be implemented.