public interface BudgetEntryBusinessSession extends OsidSession
This session provides methods to retrieve BudgetEntry
to
Business
mappings. An BudgetEntry
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 |
canLookupBudgetEntryBusinessMappings()
Tests if this user can perform lookups of entry/business mappings.
|
BudgetEntryList |
getActivitieByBusiness(Id businessId)
Gets the list of
BudgetEntry associated with a
Business. |
BudgetEntryList |
getActivitieByBusinesses(IdList businessIds)
Gets the list of
BudgetEntries corresponding to a list
of Business objects. |
IdList |
getBudgetEntryIdsByBusiness(Id businessId)
Gets the list of
BudgetEntry Ids associated with a
Business. |
IdList |
getBudgetEntryIdsByBusinesses(IdList businessIds)
Gets the list of
BudgetEntry Ids corresponding to a
list of Business objects. |
BusinessList |
getBusinessesByBudgetEntry(Id budgetEntryId)
Gets the
Business objects mapped to an
BudgetEntry. |
IdList |
getBusinessIdsByBudgetEntry(Id budgetEntryId)
Gets the
Business Ids mapped to an
BudgetEntry. |
void |
useComparativeBudgetEntryBusinessView()
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 |
usePlenaryBudgetEntryBusinessView()
A complete view of the
BudgetEntry and Business
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupBudgetEntryBusinessMappings()
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 useComparativeBudgetEntryBusinessView()
mandatory
- This method is must be implemented. void usePlenaryBudgetEntryBusinessView()
BudgetEntry
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 getBudgetEntryIdsByBusiness(Id businessId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BudgetEntry 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. BudgetEntryList getActivitieByBusiness(Id businessId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BudgetEntry
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 getBudgetEntryIdsByBusinesses(IdList businessIds) throws OperationFailedException, PermissionDeniedException
BudgetEntry Ids
corresponding to a
list of Business
objects.businessIds
- list of catalog Ids
Ids
NullArgumentException
- businessIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BudgetEntryList getActivitieByBusinesses(IdList businessIds) throws OperationFailedException, PermissionDeniedException
BudgetEntries
corresponding to a list
of Business
objects.businessIds
- list of catalog Ids
NullArgumentException
- businessIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getBusinessIdsByBudgetEntry(Id budgetEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Business
Ids
mapped to an
BudgetEntry.
budgetEntryId
- Id
of an BudgetEntry
NotFoundException
- budgetEntryId
is not
foundNullArgumentException
- budgetEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BusinessList getBusinessesByBudgetEntry(Id budgetEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Business
objects mapped to an
BudgetEntry.
budgetEntryId
- Id
of an BudgetEntry
NotFoundException
- budgetEntryId
is not
foundNullArgumentException
- budgetEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.