public interface ReportingSession extends OsidSession
This session defines methods for retrieving financial transaction reports.
This lookup session defines several views:
Accounts
with the AccountAdminSession.
The methods useFederatedBusinessView()
and
useIsolatedBusinessView()
behave as a radio group and one should
be selected before invoking any lookup methods.
Summaries may have an additional records indicated by their respective
record types. The record may not be accessed through a cast of the
Summary.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupSummaries()
Tests if this user can perform
Summary lookups. |
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
SummaryList |
getSummariesByFiscalPeriodForRootAccounts(Id fiscalPeriodId)
Gets a summary of financial transactions for a fiscal period for all
root accounts.
|
SummaryList |
getSummariesByFiscalPeriodForRootActivities(Id fiscalPeriodId)
Gets a summary of financial transactions for a fiscal period for all
root activities.
|
SummaryList |
getSummariesByYearForRootAccounts(long year)
Gets a summary of financial transactions for a fiscal year for all
root accounts.
|
SummaryList |
getSummariesByYearForRootActivities(long year)
Gets a summary of financial transactions for a fiscal year for all
root activities.
|
SummaryList |
getSummaryByFiscalPeriodForAccount(Id accountId,
Id fiscalPeriodId)
Gets a summary of financial transactions for a fiscal period for the
given account.
|
Summary |
getSummaryByFiscalPeriodForActivity(Id activityId,
Id fiscalPeriodId)
Gets a summary of financial transactions for a fiscal period for the
given activity.
|
SummaryList |
getSummaryByYearForAccount(Id accountId,
long year)
Gets a summary of financial transactions for a fiscal year for the
given account.
|
SummaryList |
getSummaryByYearForActivity(Id activityId,
long year)
Gets a summary of financial transactions for a fiscal year for the
given activity.
|
void |
useComparativeSummaryView()
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 |
useFederatedBusinessView()
Federates the view for methods in this session.
|
void |
useIsolatedBusinessView()
Isolates the view for methods in this session.
|
void |
usePlenarySummaryView()
A complete view of the
Summary 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 canLookupSummaries()
Summary
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 useComparativeSummaryView()
mandatory
- This method is must be implemented. void usePlenarySummaryView()
Summary
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. SummaryList getSummaryByYearForAccount(Id accountId, long year) throws NotFoundException, OperationFailedException, PermissionDeniedException
accountId
- the Id
of an Account
year
- a fiscal yearNotFoundException
- no Account
found
with the given Id
NullArgumentException
- accountId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SummaryList getSummariesByYearForRootAccounts(long year) throws OperationFailedException, PermissionDeniedException
year
- a fiscal yearOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SummaryList getSummaryByFiscalPeriodForAccount(Id accountId, Id fiscalPeriodId) throws NotFoundException, OperationFailedException, PermissionDeniedException
accountId
- the Id
of an Account
fiscalPeriodId
- a fiscal period Id
NotFoundException
- no Account
or
fiscalPeriodId
found with the given Id
NullArgumentException
- accountId
or
fiscalPeriodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SummaryList getSummariesByFiscalPeriodForRootAccounts(Id fiscalPeriodId) throws OperationFailedException, PermissionDeniedException
fiscalPeriodId
- a fiscal period Id
NullArgumentException
- fiscalPeriodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SummaryList getSummaryByYearForActivity(Id activityId, long year) throws NotFoundException, OperationFailedException, PermissionDeniedException
activityId
- the Id
of an Activity
year
- a fiscal yearNotFoundException
- no Activity
found
with the given Id
NullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SummaryList getSummariesByYearForRootActivities(long year) throws OperationFailedException, PermissionDeniedException
year
- a fiscal yearOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. Summary getSummaryByFiscalPeriodForActivity(Id activityId, Id fiscalPeriodId) throws NotFoundException, OperationFailedException, PermissionDeniedException
activityId
- the Id
of an Activity
fiscalPeriodId
- a fiscal period Id
Summary
NotFoundException
- no Activity
or
fiscalPeriodId
found with the given Id
NullArgumentException
- activityId
or
fiscalPeriodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SummaryList getSummariesByFiscalPeriodForRootActivities(Id fiscalPeriodId) throws OperationFailedException, PermissionDeniedException
fiscalPeriodId
- a fiscal period Id
NullArgumentException
- fiscalPeriodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.