OSID - osid.financials.SummaryQuery Service Interface Definition

Interface	osid.financials.SummaryQuery
Implements	`osid.OsidCompendiumQuery`
Description	This is the query for searching summaries. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchAccountId
Description	Matches an account `Id.`
Parameters	`osid.id.Id`	`accountId`	an account `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`accountId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAccountIdTerms
Description	Clears the account `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAccountQuery
Description	Tests if an `AccountQuery` is available.
Return	`boolean`		`true` if an account query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAccountQuery
Description	Gets the query for an account. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.AccountQuery`		the account query
Errors	UNIMPLEMENTED		`supportsAccountQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAccountQuery()` is `true.`
Method	clearAccountTerms
Description	Clears the account terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFiscalPeriodId
Description	Sets the fiscal period `Id` for this query.
Parameters	`osid.id.Id`	`fiscalPeriodId`	a fiscal period `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`fiscalPeriodId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearFiscalPeriodIdTerms
Description	Clears the fiscal period `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsFiscalPeriodQuery
Description	Tests if a `FiscalPeriodQuery` is available.
Return	`boolean`		`true` if a fiscal period query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriodQuery
Description	Gets the query for a fiscal period. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.FiscalPeriodQuery`		the fiscal period query
Errors	UNIMPLEMENTED		`supportsFiscalPeriodQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFiscalPeriodQuery()` is `true.`
Method	clearFiscalPeriodTerms
Description	Clears the fiscal period query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCredits
Description	Matches credits within the given range inclusive.
Parameters	`osid.financials.Currency`	`from`	start of range
	`osid.financials.Currency`	`to`	end of range
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditsTerms
Description	Clears the credits terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDebits
Description	Matches debits within the given range inclusive.
Parameters	`osid.financials.Currency`	`from`	start of range
	`osid.financials.Currency`	`to`	end of range
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDebitsTerms
Description	Clears the debits terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBalance
Description	Matches summaries with a delta between debits and credits.
Parameters	`decimal`	`from`	start of range
	`decimal`	`to`	end of range
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Compliance	`mandatory`		This method must be implemented.
Method	clearBalanceTerms
Description	Clears the balance terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBudget
Description	Matches a budget within the given range inclusive.
Parameters	`osid.financials.Currency`	`from`	start of range
	`osid.financials.Currency`	`to`	end of range
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBudgetTerms
Description	Clears the budget terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDelta
Description	Matches summaries with a delta between the balance and the budget.
Parameters	`decimal`	`from`	start of range
	`decimal`	`to`	end of range
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Compliance	`mandatory`		This method must be implemented.
Method	clearDeltaTerms
Description	Clears the delta terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchForecast
Description	Matches a forecast within the given range inclusive.
Parameters	`osid.financials.Currency`	`from`	start of range
	`osid.financials.Currency`	`to`	end of range
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearForecastTerms
Description	Clears the forecast terms.
Compliance	`mandatory`		This method must be implemented.
Method	getSummaryQueryRecord
Description	Gets the summary query record corresponding to the given `Summary` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`summaryRecordType`	a summary record type
Return	`osid.financials.records.SummaryQueryRecord`		the summary query 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.