org.osid.financials

Interface ReportingSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface ReportingSession
extends OsidSession

This session defines methods for retrieving financial transaction reports.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition
• isolated business view: All methods in this session operate, retrieve and pertain to accounts defined explicitly in the current business. Using an isolated view is useful for managing Accounts with the AccountAdminSession.
• federated business view: All lookup methods in this session operate, retrieve and pertain to all accounts and activities defined in this business and any other courses implicitly available in this business through business inheritence.

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getBusinessId

Id getBusinessId()

Gets the Business Id associated with this session.

Returns:

the Business Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBusiness

Business getBusiness()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Business associated with this session.

Returns:

the business

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupSummaries

boolean canLookupSummaries()

Tests if this user can perform 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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeSummaryView

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. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenarySummaryView

void usePlenarySummaryView()

A complete view of the 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.

Compliance:

mandatory - This method is must be implemented.

useFederatedBusinessView

void useFederatedBusinessView()

Federates the view for methods in this session. A federated view will include accounts and activities in catalogs which are children of this catalog in the business hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedBusinessView

void useIsolatedBusinessView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this business only.

Compliance:

mandatory - This method is must be implemented.

getSummaryByYearForAccount

SummaryList getSummaryByYearForAccount(Id accountId,
                                     long year)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Gets a summary of financial transactions for a fiscal year for the given account. A summary is returned for each fiscal time period within the fiscal year.

Parameters:

accountId - the Id of an Account

year - a fiscal year

Returns:

the account summaries

Throws:

NotFoundException - no Account found with the given Id

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSummariesByYearForRootAccounts

SummaryList getSummariesByYearForRootAccounts(long year)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets a summary of financial transactions for a fiscal year for all root accounts. A summary is returned for each fiscal time period within the fiscal year.

Parameters:

year - a fiscal year

Returns:

the account summaries

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSummaryByFiscalPeriodForAccount

SummaryList getSummaryByFiscalPeriodForAccount(Id accountId,
                                             Id fiscalPeriodId)
                                               throws NotFoundException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

Gets a summary of financial transactions for a fiscal period for the given account.

Parameters:

accountId - the Id of an Account

fiscalPeriodId - a fiscal period Id

Returns:

the account summaries

Throws:

NotFoundException - no Account or fiscalPeriodId found with the given Id

NullArgumentException - accountId or fiscalPeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSummariesByFiscalPeriodForRootAccounts

SummaryList getSummariesByFiscalPeriodForRootAccounts(Id fiscalPeriodId)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets a summary of financial transactions for a fiscal period for all root accounts.

Parameters:

fiscalPeriodId - a fiscal period Id

Returns:

the account summaries

Throws:

NullArgumentException - fiscalPeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSummaryByYearForActivity

SummaryList getSummaryByYearForActivity(Id activityId,
                                      long year)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets a summary of financial transactions for a fiscal year for the given activity. A summary is returned for each fiscal time period within the fiscal year.

Parameters:

activityId - the Id of an Activity

year - a fiscal year

Returns:

the activity summaries

Throws:

NotFoundException - no Activity found with the given Id

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSummariesByYearForRootActivities

SummaryList getSummariesByYearForRootActivities(long year)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets a summary of financial transactions for a fiscal year for all root activities. A summary is returned for each fiscal time period within the fiscal year.

Parameters:

year - a fiscal year

Returns:

the activity summaries

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSummaryByFiscalPeriodForActivity

Summary getSummaryByFiscalPeriodForActivity(Id activityId,
                                          Id fiscalPeriodId)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Gets a summary of financial transactions for a fiscal period for the given activity.

Parameters:

activityId - the Id of an Activity

fiscalPeriodId - a fiscal period Id

Returns:

the returned Summary

Throws:

NotFoundException - no Activity or fiscalPeriodId found with the given Id

NullArgumentException - activityId or fiscalPeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSummariesByFiscalPeriodForRootActivities

SummaryList getSummariesByFiscalPeriodForRootActivities(Id fiscalPeriodId)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Gets a summary of financial transactions for a fiscal period for all root activities.

Parameters:

fiscalPeriodId - a fiscal period Id

Returns:

the activity summaries

Throws:

NullArgumentException - fiscalPeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.