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

MethodmatchBudgetId
Description

Sets the budget Id for this query.

Parametersosid.id.IdbudgetIda budget Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT budgetId is null
CompliancemandatoryThis method must be implemented.
MethodclearBudgetIdTerms
Description

Clears the budget Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBudgetQuery
Description

Tests if a BudgetQuery is available.

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

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

Returnosid.financials.budgeting.BudgetQuerythe payer query
ErrorsUNIMPLEMENTEDthe budget query
ComplianceoptionalThis method must be implemented if supportsBudgetQuery() is true.
MethodclearBudgetTerms
Description

Clears the budget terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAccountId
Description

Sets the account Id for this query.

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

Clears the account Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAccountQuery
Description

Tests if an AccountQuery is available.

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

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

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

Matches entries that have any account set.

Parametersbooleanmatch true to match entries with any account, false to match entries with no account
CompliancemandatoryThis method must be implemented.
MethodclearAccountTerms
Description

Clears the account terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAmount
Description

Matches the amount between the given range inclusive.

Parametersosid.financials.Currencylowstart of range
osid.financials.Currencyhighend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
NULL_ARGUMENT low or high is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyAmount
Description

Matches entries that have any amount set.

Parametersbooleanmatch true to match entries with any amount, false to match entries with no amount
CompliancemandatoryThis method must be implemented.
MethodclearAmountTerms
Description

Clears the amount terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDebit
Description

Matches entries that have debit amounts.

Parametersbooleanmatch true to match entries with a debit amount, false to match entries with a credit amount
CompliancemandatoryThis method must be implemented.
MethodclearDebitTerms
Description

Clears the debit terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBusinessId
Description

Sets the business Id for this query to match budget entries 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.
MethodgetBudgetEntryQueryRecord
Description

Gets the budget entry query record corresponding to the given BudgetEntry record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypebudgetEntryRecordTypea budget entry record type
Returnosid.financials.budgeting.records.BudgetEntryQueryRecordthe budget entry query record
ErrorsNULL_ARGUMENT budgetEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(budgetEntryRecordType) is false
CompliancemandatoryThis method must be implemented.