public interface BudgetEntryQuery extends OsidRelationshipQuery
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.
Modifier and Type | Method and Description |
---|---|
void |
clearAccountIdTerms()
Clears the account
Id terms. |
void |
clearAccountTerms()
Clears the account terms.
|
void |
clearAmountTerms()
Clears the amount terms.
|
void |
clearBudgetIdTerms()
Clears the budget
Id terms. |
void |
clearBudgetTerms()
Clears the budget terms.
|
void |
clearBusinessIdTerms()
Clears the business
Id terms. |
void |
clearBusinessTerms()
Clears the business terms.
|
void |
clearDebitTerms()
Clears the debit terms.
|
AccountQuery |
getAccountQuery()
Gets the query for an account.
|
BudgetEntryQueryRecord |
getBudgetEntryQueryRecord(Type budgetEntryRecordType)
Gets the budget entry query record corresponding to the given
BudgetEntry record Type. |
BudgetQuery |
getBudgetQuery()
Gets the query for a budget.
|
BusinessQuery |
getBusinessQuery()
Gets the query for a business.
|
void |
matchAccountId(Id accountId,
boolean match)
Sets the account
Id for this query. |
void |
matchAmount(Currency low,
Currency high,
boolean match)
Matches the amount between the given range inclusive.
|
void |
matchAnyAccount(boolean match)
Matches entries that have any account set.
|
void |
matchAnyAmount(boolean match)
Matches entries that have any amount set.
|
void |
matchBudgetId(Id budgetId,
boolean match)
Sets the budget
Id for this query. |
void |
matchBusinessId(Id businessId,
boolean match)
Sets the business
Id for this query to match budget
entries assigned to businesses. |
void |
matchDebit(boolean match)
Matches entries that have debit amounts.
|
boolean |
supportsAccountQuery()
Tests if an
AccountQuery is available. |
boolean |
supportsBudgetQuery()
Tests if a
BudgetQuery is available. |
boolean |
supportsBusinessQuery()
Tests if a
BusinessQuery is available. |
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery
clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchBudgetId(Id budgetId, boolean match)
Id
for this query.budgetId
- a budget Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- budgetId
is
null
mandatory
- This method must be implemented. void clearBudgetIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsBudgetQuery()
BudgetQuery
is available. true
if a budget query is available,
false
otherwisemandatory
- This method must be implemented. BudgetQuery getBudgetQuery()
OR
term.UnimplementedException
- the budget queryoptional
- This method must be implemented if
supportsBudgetQuery()
is true.
void clearBudgetTerms()
mandatory
- This method must be implemented. void matchAccountId(Id accountId, boolean match)
Id
for this query.accountId
- an account Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- accountId
is
null
mandatory
- This method must be implemented. void clearAccountIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAccountQuery()
AccountQuery
is available. true
if an account query is available,
false
otherwisemandatory
- This method must be implemented. AccountQuery getAccountQuery()
OR
term.UnimplementedException
- supportsAccountQuery()
is false
optional
- This method must be implemented if
supportsAccountQuery()
is true.
void matchAnyAccount(boolean match)
match
- true
to match entries with any account,
false
to match entries with no accountmandatory
- This method must be implemented. void clearAccountTerms()
mandatory
- This method must be implemented. void matchAmount(Currency low, Currency high, boolean match)
low
- start of rangehigh
- end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
NullArgumentException
- low
or
high
is null
mandatory
- This method must be implemented. void matchAnyAmount(boolean match)
match
- true
to match entries with any amount,
false
to match entries with no amountmandatory
- This method must be implemented. void clearAmountTerms()
mandatory
- This method must be implemented. void matchDebit(boolean match)
match
- true
to match entries with a debit
amount, false
to match entries with a credit
amountmandatory
- This method must be implemented. void clearDebitTerms()
mandatory
- This method must be implemented. void matchBusinessId(Id businessId, boolean match)
Id
for this query to match budget
entries assigned to businesses.businessId
- the business Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- businessId
is
null
mandatory
- This method must be implemented. void clearBusinessIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsBusinessQuery()
BusinessQuery
is available. true
if a business query is available,
false
otherwisemandatory
- This method must be implemented. BusinessQuery getBusinessQuery()
OR
term.UnimplementedException
- supportsBusinessQuery()
is false
optional
- This method must be implemented if
supportsBusinessQuery()
is true.
void clearBusinessTerms()
mandatory
- This method must be implemented. BudgetEntryQueryRecord getBudgetEntryQueryRecord(Type budgetEntryRecordType) throws OperationFailedException
BudgetEntry
record Type.
Multiple record
retrievals produce a nested OR
term.budgetEntryRecordType
- a budget entry record typeNullArgumentException
- budgetEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(budgetEntryRecordType)
is false
mandatory
- This method must be implemented.