public interface BudgetBusinessSession extends OsidSession
This session provides methods to retrieve Budget
to
Business
mappings. A Budget
may appear in
multiple Business
objects. Each catalog may have its own
authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupBudgetBusinessMappings()
Tests if this user can perform lookups of budget/business mappings.
|
IdList |
getBudgetIdsByBusiness(Id businessId)
Gets the list of
Budget Ids associated with a
Business. |
IdList |
getBudgetIdsByBusinesses(IdList businessIds)
Gets the list of
Budget Ids corresponding to a list of
Business objects. |
BudgetList |
getBudgetsByBusiness(Id businessId)
Gets the list of
Budgets associated with a
Business. |
BudgetList |
getBudgetsByBusinesses(IdList businessIds)
Gets the list of
Budgets corresponding to a list of
Business objects. |
BusinessList |
getBusinessesByBudget(Id budgetId)
Gets the
Business objects mapped to a Budget. |
IdList |
getBusinessIdsByBudget(Id budgetId)
Gets the
Business Ids mapped to a
Budget. |
void |
useComparativeBudgetBusinessView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
usePlenaryBudgetBusinessView()
A complete view of the
Budget and Business
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupBudgetBusinessMappings()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeBudgetBusinessView()
mandatory
- This method is must be implemented. void usePlenaryBudgetBusinessView()
Budget
and Business
returns is desired. Methods will return what is requested or
result in an error. This view is used when greater precision is
desired at the expense of interoperability.mandatory
- This method is must be implemented. IdList getBudgetIdsByBusiness(Id businessId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Budget Ids
associated with a
Business.
businessId
- Id
of the Business
Ids
NotFoundException
- businessId
is not
foundNullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BudgetList getBudgetsByBusiness(Id businessId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Budgets
associated with a
Business.
businessId
- Id
of the Business
NotFoundException
- businessId
is not
foundNullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getBudgetIdsByBusinesses(IdList businessIds) throws OperationFailedException, PermissionDeniedException
Budget Ids
corresponding to a list of
Business
objects.businessIds
- list of business Ids
Ids
NullArgumentException
- businessIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BudgetList getBudgetsByBusinesses(IdList businessIds) throws OperationFailedException, PermissionDeniedException
Budgets
corresponding to a list of
Business
objects.businessIds
- list of business Ids
NullArgumentException
- businessIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getBusinessIdsByBudget(Id budgetId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Business
Ids
mapped to a
Budget.
budgetId
- Id
of a Budget
NotFoundException
- budgetId
is not
foundNullArgumentException
- budgetId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BusinessList getBusinessesByBudget(Id budgetId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Business
objects mapped to a Budget.
budgetId
- Id
of a Budget
NotFoundException
- budgetId
is not
foundNullArgumentException
- budgetId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.