OSID - osid.financials.budgeting.BudgetEntryQuery Service Interface Definition

Interface	osid.financials.budgeting.BudgetEntryQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.financials.budgeting.BudgetEntryQuerySession`
	`osid.financials.budgeting.BudgetEntrySearchSession`
	`osid.financials.budgeting.BudgetEntrySmartBusinessSession`
	`osid.financials.budgeting.BudgetQuery`
Description	This is the query for searching budget entries. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchBudgetId
Description	Sets the budget `Id` for this query.
Parameters	`osid.id.Id`	`budgetId`	a budget `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`budgetId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBudgetIdTerms
Description	Clears the budget `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetQuery
Description	Tests if a `BudgetQuery` is available.
Return	`boolean`		`true` if a budget query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetQuery
Description	Gets the query for a budget. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.budgeting.BudgetQuery`		the payer query
Errors	UNIMPLEMENTED		the budget query
Compliance	`optional`		This method must be implemented if `supportsBudgetQuery()` is `true`.
Method	clearBudgetTerms
Description	Clears the budget terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAccountId
Description	Sets the account `Id` for this query.
Parameters	`osid.id.Id`	`accountId`	an account `Id`
Parameters	`boolean`	`match`	`true` if 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	matchAnyAccount
Description	Matches entries that have any account set.
Parameters	`boolean`	`match`	`true` to match entries with any account, `false` to match entries with no account
Compliance	`mandatory`		This method must be implemented.
Method	clearAccountTerms
Description	Clears the account terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAmount
Description	Matches the amount between the given range inclusive.
Parameters	`osid.financials.Currency`	`low`	start of range
	`osid.financials.Currency`	`high`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Errors	NULL_ARGUMENT		`low` or `high` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyAmount
Description	Matches entries that have any amount set.
Parameters	`boolean`	`match`	`true` to match entries with any amount, `false` to match entries with no amount
Compliance	`mandatory`		This method must be implemented.
Method	clearAmountTerms
Description	Clears the amount terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDebit
Description	Matches entries that have debit amounts.
Parameters	`boolean`	`match`	`true` to match entries with a debit amount, `false` to match entries with a credit amount
Compliance	`mandatory`		This method must be implemented.
Method	clearDebitTerms
Description	Clears the debit terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBusinessId
Description	Sets the business `Id` for this query to match budget entries assigned to businesses.
Parameters	`osid.id.Id`	`businessId`	the business `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`businessId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBusinessIdTerms
Description	Clears the business `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessQuery
Description	Tests if a `BusinessQuery` is available.
Return	`boolean`		`true` if a business query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessQuery
Description	Gets the query for a business. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.BusinessQuery`		the business query
Errors	UNIMPLEMENTED		`supportsBusinessQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBusinessQuery()` is `true`.
Method	clearBusinessTerms
Description	Clears the business terms.
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetEntryQueryRecord
Description	Gets the budget entry query record corresponding to the given `BudgetEntry` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`budgetEntryRecordType`	a budget entry record type
Return	`osid.financials.budgeting.records.BudgetEntryQueryRecord`		the budget entry query record
Errors	NULL_ARGUMENT		`budgetEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(budgetEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.