Interface | osid.financials.budgeting.BudgetEntryQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
Description |
This is the query for searching budget entries. Each method
match specifies an | ||
Method | matchBudgetId | ||
Description |
Sets the budget | ||
Parameters | osid.id.Id | budgetId | a budget Id |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsBudgetQuery | ||
Description |
Tests if a | ||
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 | ||
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 | ||
Parameters | osid.id.Id | accountId | an account Id |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAccountQuery | ||
Description |
Tests if an | ||
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 | ||
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 | |
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 | ||
Parameters | osid.id.Id | businessId | the business Id |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsBusinessQuery | ||
Description |
Tests if a | ||
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 | ||
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 | ||
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. |