OSID - osid.financials.ReportingSession Service Interface Definition

Interface	osid.financials.ReportingSession
Implements	`osid.OsidSession`
Description	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	getBusinessId
Description	Gets the `Business` `Id` associated with this session.
Return	`osid.id.Id`		the `Business Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBusiness
Description	Gets the `Business` associated with this session.
Return	`osid.financials.Business`		the business
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupSummaries
Description	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.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeSummaryView
Description	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.
Method	usePlenarySummaryView
Description	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.
Method	useFederatedBusinessView
Description	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.
Method	useIsolatedBusinessView
Description	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.
Method	getSummaryByYearForAccount
Description	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	`osid.id.Id`	`accountId`	the `Id` of an `Account`
Parameters	`cardinal`	`year`	a fiscal year
Return	`osid.financials.SummaryList`		the account summaries
Errors	NOT_FOUND		no `Account` found with the given `Id`
	NULL_ARGUMENT		`accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSummariesByYearForRootAccounts
Description	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	`cardinal`	`year`	a fiscal year
Return	`osid.financials.SummaryList`		the account summaries
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSummaryByFiscalPeriodForAccount
Description	Gets a summary of financial transactions for a fiscal period for the given account.
Parameters	`osid.id.Id`	`accountId`	the `Id` of an `Account`
Parameters	`osid.id.Id`	`fiscalPeriodId`	a fiscal period `Id`
Return	`osid.financials.SummaryList`		the account summaries
Errors	NOT_FOUND		no `Account` or `fiscalPeriodId` found with the given `Id`
	NULL_ARGUMENT		`accountId` or `fiscalPeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSummariesByFiscalPeriodForRootAccounts
Description	Gets a summary of financial transactions for a fiscal period for all root accounts.
Parameters	`osid.id.Id`	`fiscalPeriodId`	a fiscal period `Id`
Return	`osid.financials.SummaryList`		the account summaries
Errors	NULL_ARGUMENT		`fiscalPeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSummaryByYearForActivity
Description	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	`osid.id.Id`	`activityId`	the `Id` of an `Activity`
Parameters	`cardinal`	`year`	a fiscal year
Return	`osid.financials.SummaryList`		the activity summaries
Errors	NOT_FOUND		no `Activity` found with the given `Id`
	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSummariesByYearForRootActivities
Description	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	`cardinal`	`year`	a fiscal year
Return	`osid.financials.SummaryList`		the activity summaries
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSummaryByFiscalPeriodForActivity
Description	Gets a summary of financial transactions for a fiscal period for the given activity.
Parameters	`osid.id.Id`	`activityId`	the `Id` of an `Activity`
Parameters	`osid.id.Id`	`fiscalPeriodId`	a fiscal period `Id`
Return	`osid.financials.Summary`		the returned `Summary`
Errors	NOT_FOUND		no `Activity` or `fiscalPeriodId` found with the given `Id`
	NULL_ARGUMENT		`activityId` or `fiscalPeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSummariesByFiscalPeriodForRootActivities
Description	Gets a summary of financial transactions for a fiscal period for all root activities.
Parameters	`osid.id.Id`	`fiscalPeriodId`	a fiscal period `Id`
Return	`osid.financials.SummaryList`		the activity summaries
Errors	NULL_ARGUMENT		`fiscalPeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.