OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.AccountQuery
Implementsosid.OsidObjectQuery
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.

MethodmatchCreditBalance
Description

Matches accounts that are credit accounts.

Parametersbooleanmatch true to match accounts that are credit account, false to match accounts debit accounts
CompliancemandatoryThis method must be implemented.
MethodclearCreditBalanceTerms
Description

Clears the credit balance terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCode
Description

Matches an account code.

Parametersstringcodea code
osid.type.TypestringMatchTypethe string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT code is not of stringMatchType
NULL_ARGUMENT code is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyCode
Description

Matches an account that has any code assigned.

Parametersbooleanmatch true to match accounts with any code, false to match accounts with no code
CompliancemandatoryThis method must be implemented.
MethodclearCodeTerms
Description

Clears the code terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSummaryQuery
Description

Tests if a SummaryQuery is available.

Returnboolean true if a summery query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSummaryQuery
Description

Gets the query for a summary. Multiple retrievals produce a nested OR term.

Returnosid.financials.SummaryQuerythe summery query
ErrorsUNIMPLEMENTED supportsSummeryQuery() is false
ComplianceoptionalThis method must be implemented if supportsSupervisorQuery() is true.
MethodclearSummaryTerms
Description

Clears the summary terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorAccountId
Description

Sets the account Id for this query to match accounts that have the specified account as an ancestor.

Parametersosid.id.IdaccountIdan account Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT accountId is null
CompliancemandatoryThis method must be implemented.
MethodclearAncestorAccountIdTerms
Description

Clears the ancestor account Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorAccountQuery
Description

Tests if an AccountQuery is available.

Returnboolean true if an account query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAncestorAccountQuery
Description

Gets the query for an account. Multiple retrievals produce a nested OR term.

Returnosid.financials.AccountQuerythe account query
ErrorsUNIMPLEMENTED supportsAncestorAccountQuery() is false
ComplianceoptionalThis method must be implemented if supportsAncestorAccountQuery() is true.
MethodmatchAnyAncestorAccount
Description

Matches accounts with any account ancestor.

Parametersbooleanmatch true to match accounts with any ancestor, false to match root accounts
CompliancemandatoryThis method must be implemented.
MethodclearAncestorAccountTerms
Description

Clears the ancestor account query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantAccountId
Description

Sets the account Id for this query to match accounts that have the specified account as a descendant.

Parametersosid.id.IdaccountIdan account Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT accountId is null
CompliancemandatoryThis method must be implemented.
MethodclearDescendantAccountIdTerms
Description

Clears the descendant account Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantAccountQuery
Description

Tests if an AccountQuery is available.

Returnboolean true if an account query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDescendantAccountQuery
Description

Gets the query for an account. Multiple retrievals produce a nested OR term.

Returnosid.financials.AccountQuerythe account query
ErrorsUNIMPLEMENTED supportsDescendantAccountQuery() is false
ComplianceoptionalThis method must be implemented if supportsDescendantAccountQuery() is true.
MethodmatchAnyDescendantAccount
Description

Matches accounts with any account descendant.

Parametersbooleanmatch true to match accounts with any descendant, false to match leaf accounts
CompliancemandatoryThis method must be implemented.
MethodclearDescendantAccountTerms
Description

Clears the descendant account query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBusinessId
Description

Sets the business Id for this query to match accounts assigned to businesses.

Parametersosid.id.IdbusinessIdthe business Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT businessId is null
CompliancemandatoryThis method must be implemented.
MethodclearBusinessIdTerms
Description

Clears the business Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBusinessQuery
Description

Tests if a BusinessQuery is available.

Returnboolean true if a business query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBusinessQuery
Description

Gets the query for a business. Multiple retrievals produce a nested OR term.

Returnosid.financials.BusinessQuerythe business query
ErrorsUNIMPLEMENTED supportsBusinessQuery() is false
ComplianceoptionalThis method must be implemented if supportsBusinessQuery() is true.
MethodclearBusinessTerms
Description

Clears the business terms.

CompliancemandatoryThis method must be implemented.
MethodgetAccountQueryRecord
Description

Gets the account query record corresponding to the given Account record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeaccountRecordTypean account record type
Returnosid.financials.records.AccountQueryRecordthe account query record
ErrorsNULL_ARGUMENT accountRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(accountRecordType) is false
CompliancemandatoryThis method must be implemented.