public interface BudgetLookupSession extends OsidSession
This session defines methods for retrieving budgets.
This lookup session defines several views:
Budgets
with the BudgetAdminSession.
The methods useFederatedBusinessView()
and
useIsolatedBusinessView()
behave as a radio group and one should
be selected before invoking any lookup methods.
Budgets may have an additional records indicated by their respective
record types. The record may not be accessed through a cast of the
Budget.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupBudgets()
Tests if this user can perform
Budget lookups. |
Budget |
getBudget(Id budgetId)
Gets the
Budget specified by its Id. |
BudgetList |
getBudgets()
Gets all
Budgets. |
BudgetList |
getBudgetsByGenusType(Type budgetGenusType)
Gets a
BudgetList corresponding to the given budget
genus Type which does not include budgets of types
derived from the specified Type. |
BudgetList |
getBudgetsByIds(IdList budgetIds)
Gets a
BudgetList corresponding to the given
IdList. |
BudgetList |
getBudgetsByParentGenusType(Type budgetGenusType)
Gets a
BudgetList corresponding to the given budget
genus Type and include any additional budgets with
genus types derived from the specified Type. |
BudgetList |
getBudgetsByRecordType(Type budgetRecordType)
Gets a
BudgetList containing the given budget record
Type. |
BudgetList |
getBudgetsForActivity(Id activityId)
Gets a
BudgetList for the given activity. |
BudgetList |
getBudgetsForActivityAndFiscalPeriod(Id activityId,
Id fiscalPeriodId)
Gets a
BudgetList for the given activity and fiscal
period. |
BudgetList |
getBudgetsForActivityAndFiscalPeriodOnDate(Id activityId,
Id fiscalPeriodId,
DateTime from,
DateTime to)
Gets a
BudgetList for the given activity, fiscal
period, and effective during the entire given date range inclusive but
not confined to the date range. |
BudgetList |
getBudgetsForActivityOnDate(Id activityId,
DateTime from,
DateTime to)
Gets a
BudgetList for the given activity and effective
during the entire given date range inclusive but not confined to the
date range. |
BudgetList |
getBudgetsForFiscalPeriod(Id fiscalPeriodId)
Gets a
BudgetList for the given fiscal period. |
BudgetList |
getBudgetsForFiscalPeriodOnDate(Id fiscalPeriodId,
DateTime from,
DateTime to)
Gets a
BudgetList for the given fiscal period and
effective during the entire given date range inclusive but not
confined to the date range. |
BudgetList |
getBudgetsOnDate(DateTime from,
DateTime to)
Gets a
BudgetList effective during the entire given
date range inclusive but not confined to the date range. |
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
void |
useAnyEffectiveBudgetView()
All budgets of any effective dates are returned by methods in this
session.
|
void |
useComparativeBudgetView()
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 |
useEffectiveBudgetView()
Only budgets whose effective dates are current are returned by methods
in this session.
|
void |
useFederatedBusinessView()
Federates the view for methods in this session.
|
void |
useIsolatedBusinessView()
Isolates the view for methods in this session.
|
void |
usePlenaryBudgetView()
A complete view of the
Budget returns is desired. |
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 canLookupBudgets()
Budget
lookups. A return
of true does not guarantee successful authorization. A return of false
indicates that it is known all methods in this session will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer lookup operations to unauthorized
users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeBudgetView()
mandatory
- This method is must be implemented. void usePlenaryBudgetView()
Budget
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. void useFederatedBusinessView()
mandatory
- This method is must be implemented. void useIsolatedBusinessView()
mandatory
- This method is must be implemented. void useEffectiveBudgetView()
mandatory
- This method is must be implemented. void useAnyEffectiveBudgetView()
mandatory
- This method is must be implemented. Budget getBudget(Id budgetId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Budget
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Budget
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to a
Budget
and retained for compatibility.
In effective mode, budgets are returned that are currently effective.
In any effective mode, effective budgets and those currently expired
are returned.budgetId
- the Id
of the Budget
to
retrieve Budget
NotFoundException
- no Budget
found with
the given Id
NullArgumentException
- budgetId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BudgetList getBudgetsByIds(IdList budgetIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
BudgetList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
budgets specified in the Id
list, in the order of the
list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Budgets
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In effective mode, budgets are returned that are currently effective.
In any effective mode, effective budgets and those currently expired
are returned.budgetIds
- the list of Ids
to retrieve Budget
listNotFoundException
- an Id was
not foundNullArgumentException
- budgetIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BudgetList getBudgetsByGenusType(Type budgetGenusType) throws OperationFailedException, PermissionDeniedException
BudgetList
corresponding to the given budget
genus Type
which does not include budgets of types
derived from the specified Type.
In plenary mode, the returned list contains all known
budgets or an error results. Otherwise, the returned list may contain
only those budgets that are accessible through this session.
In effective mode, budgets are returned that are currently effective.
In any effective mode, effective budgets and those currently expired
are returned.budgetGenusType
- a budget genus type Budget
listNullArgumentException
- budgetGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BudgetList getBudgetsByParentGenusType(Type budgetGenusType) throws OperationFailedException, PermissionDeniedException
BudgetList
corresponding to the given budget
genus Type
and include any additional budgets with
genus types derived from the specified Type.
In plenary mode, the returned list contains all known
budgets or an error results. Otherwise, the returned list may contain
only those budgets that are accessible through this session.
In effective mode, budgets are returned that are currently effective.
In any effective mode, effective budgets and those currently expired
are returned.budgetGenusType
- a budget genus type Budget
listNullArgumentException
- budgetGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BudgetList getBudgetsByRecordType(Type budgetRecordType) throws OperationFailedException, PermissionDeniedException
BudgetList
containing the given budget record
Type.
In plenary mode, the returned list contains all known mode,s or an
error results. Otherwise, the returned list may contain only those
budgets that are accessible through this session.
In effective mode, budgets are returned that are currently effective.
In any effective mode, effective budgets and those currently expired
are returned.budgetRecordType
- a budget record type Budget
listNullArgumentException
- budgetRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BudgetList getBudgetsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
BudgetList
effective during the entire given
date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known budgets or an
error results. Otherwise, the returned list may contain only those
budgets that are accessible through this session.
In effective mode, budgets are returned that are currently effective
in addition to being effective in the given date range. In any
effective mode, effective budgets and those currently expired are
returned.from
- start of date rangeto
- end of date range Budget
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BudgetList getBudgetsForActivity(Id activityId) throws OperationFailedException, PermissionDeniedException
BudgetList
for the given activity.
In plenary mode, the returned list contains all known mode,s or an
error results. Otherwise, the returned list may contain only those
budgets that are accessible through this session.
In effective mode, budgets are returned that are currently effective.
In any effective mode, effective budgets and those currently expired
are returned.activityId
- an activity Id
Budget
listNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BudgetList getBudgetsForActivityOnDate(Id activityId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
BudgetList
for the given activity and effective
during the entire given date range inclusive but not confined to the
date range.
In plenary mode, the returned list contains all known budgets or an
error results. Otherwise, the returned list may contain only those
budgets that are accessible through this session.
In effective mode, budgets are returned that are currently effective
in addition to being effective in the given date range. In any
effective mode, effective budgets and those currently expired are
returned.activityId
- an activity Id
from
- start of date rangeto
- end of date range Budget
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- activityId, from or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BudgetList getBudgetsForFiscalPeriod(Id fiscalPeriodId) throws OperationFailedException, PermissionDeniedException
BudgetList
for the given fiscal period.
In plenary mode, the returned list contains all known mode,s or an
error results. Otherwise, the returned list may contain only those
budgets that are accessible through this session.
In effective mode, budgets are returned that are currently effective.
In any effective mode, effective budgets and those currently expired
are returned.fiscalPeriodId
- a fiscal period Id
Budget
listNullArgumentException
- fiscalPeriodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BudgetList getBudgetsForFiscalPeriodOnDate(Id fiscalPeriodId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
BudgetList
for the given fiscal period and
effective during the entire given date range inclusive but not
confined to the date range.
In plenary mode, the returned list contains all known budgets or an
error results. Otherwise, the returned list may contain only those
budgets that are accessible through this session.
In effective mode, budgets are returned that are currently effective
in addition to being effective in the given date range. In any
effective mode, effective budgets and those currently expired are
returned.fiscalPeriodId
- a fiscal period Id
from
- start of date rangeto
- end of date range Budget
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- fiscalPeriodId, from or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BudgetList getBudgetsForActivityAndFiscalPeriod(Id activityId, Id fiscalPeriodId) throws OperationFailedException, PermissionDeniedException
BudgetList
for the given activity and fiscal
period.
In plenary mode, the returned list contains all known mode,s or an
error results. Otherwise, the returned list may contain only those
budgets that are accessible through this session.
In effective mode, budgets are returned that are currently effective.
In any effective mode, effective budgets and those currently expired
are returned.activityId
- an activity Id
fiscalPeriodId
- a fiscal period Id
Budget
listNullArgumentException
- activityId
or
fiscalPeriodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BudgetList getBudgetsForActivityAndFiscalPeriodOnDate(Id activityId, Id fiscalPeriodId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
BudgetList
for the given activity, fiscal
period, and effective during the entire given date range inclusive but
not confined to the date range.
In plenary mode, the returned list contains all known budgets or an
error results. Otherwise, the returned list may contain only those
budgets that are accessible through this session.
In effective mode, budgets are returned that are currently effective
in addition to being effective in the given date range. In any
effective mode, effective budgets and those currently expired are
returned.activityId
- an activity Id
fiscalPeriodId
- a fiscal period Id
from
- start of date rangeto
- end of date range Budget
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- activityId,
fiscalPeriodId, from or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BudgetList getBudgets() throws OperationFailedException, PermissionDeniedException
Budgets.
In plenary mode, the returned list contains all known budgets or an
error results. Otherwise, the returned list may contain only those
budgets that are accessible through this session.
In effective mode, budgets are returned that are currently effective.
In any effective mode, effective budgets and those currently expired
are returned. Budgets
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.