OSID - osid.financials.Summary Service Interface Definition

Interface	osid.financials.Summary
Implements	`osid.OsidCompendium`
Used By	`osid.financials.ReportingSession`
Used By	`osid.financials.SummaryList`
Description	A `Summary` represents a financial summary of an `Account` in a time period.
Method	getAccountId
Description	Gets the `Id` of the account.
Return	`osid.id.Id`		the account `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getAccount
Description	Gets the account.
Return	`osid.financials.Account`		the account
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriodId
Description	Gets the `Id` of the fiscal period
Return	`osid.id.Id`		the fiscal period `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriod
Description	Gets the fiscal period
Return	`osid.financials.FiscalPeriod`		the fiscal period
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCredits
Description	Gets the credits for this fiscal period.
Return	`osid.financials.Currency`		the credits
Compliance	`mandatory`		This method must be implemented.
Method	getDebits
Description	Gets the debits for this fiscal period.
Return	`osid.financials.Currency`		the debits
Compliance	`mandatory`		This method must be implemented.
Method	isBudgeted
Description	Tests if this the account on this activity has a budget for this time period.
Return	`boolean`		`true` if a budget is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBudget
Description	Gets the budget.
Return	`osid.financials.Currency`		the budget
Errors	ILLEGAL_STATE		`isBudgeted()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasForecast
Description	Tests if this the account on this activity has a forecast for this time period.
Return	`boolean`		`true` if a forecast is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getForecast
Description	Gets the forecast
Return	`osid.financials.Currency`		the forecast
Errors	ILLEGAL_STATE		`hasForecast()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getSummaryRecord
Description	Gets the summary record corresponding to the given `Summary` record `Type`.This method is used to retrieve an object implementing the requested record. The `summaryRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(summaryRecordType)` is `true`.
Parameters	`osid.type.Type`	`summaryRecordType`	the type of summary record to retrieve
Return	`osid.financials.records.SummaryRecord`		the summary record
Errors	NULL_ARGUMENT		`summaryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(summaryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.