OSID - osid.financials.AccountQuery Service Interface Definition

Interface	osid.financials.AccountQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidFederateableQuery`
Description	This is the query for searching accounts. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchCreditBalance
Description	Matches accounts that are credit accounts.
Parameters	`boolean`	`match`	`true` to match accounts that are credit account, `false` to match accounts debit accounts
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditBalanceTerms
Description	Clears the credit balance terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCode
Description	Matches an account code.
Parameters	`string`	`code`	a code
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`code` is not of `stringMatchType`
	NULL_ARGUMENT		`code` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCode
Description	Matches an account that has any code assigned.
Parameters	`boolean`	`match`	`true` to match accounts with any code, `false` to match accounts with no code
Compliance	`mandatory`		This method must be implemented.
Method	clearCodeTerms
Description	Clears the code terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSummaryQuery
Description	Tests if a `SummaryQuery` is available.
Return	`boolean`		`true` if a summery query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSummaryQuery
Description	Gets the query for a summary. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.SummaryQuery`		the summery query
Errors	UNIMPLEMENTED		`supportsSummeryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSupervisorQuery()` is `true.`
Method	clearSummaryTerms
Description	Clears the summary terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorAccountId
Description	Sets the account `Id` for this query to match accounts that have the specified account as an ancestor.
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	clearAncestorAccountIdTerms
Description	Clears the ancestor account `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorAccountQuery
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	getAncestorAccountQuery
Description	Gets the query for an account. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.AccountQuery`		the account query
Errors	UNIMPLEMENTED		`supportsAncestorAccountQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorAccountQuery()` is `true.`
Method	matchAnyAncestorAccount
Description	Matches accounts with any account ancestor.
Parameters	`boolean`	`match`	`true` to match accounts with any ancestor, `false` to match root accounts
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorAccountTerms
Description	Clears the ancestor account query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantAccountId
Description	Sets the account `Id` for this query to match accounts that have the specified account as a descendant.
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	clearDescendantAccountIdTerms
Description	Clears the descendant account `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantAccountQuery
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	getDescendantAccountQuery
Description	Gets the query for an account. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.AccountQuery`		the account query
Errors	UNIMPLEMENTED		`supportsDescendantAccountQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantAccountQuery()` is `true.`
Method	matchAnyDescendantAccount
Description	Matches accounts with any account descendant.
Parameters	`boolean`	`match`	`true` to match accounts with any descendant, `false` to match leaf accounts
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantAccountTerms
Description	Clears the descendant account query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBusinessId
Description	Sets the business `Id` for this query to match accounts 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	getAccountQueryRecord
Description	Gets the account query record corresponding to the given `Account` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`accountRecordType`	an account record type
Return	`osid.financials.records.AccountQueryRecord`		the account query record
Errors	NULL_ARGUMENT		`accountRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(accountRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.