public interface SummaryQuery extends OsidCompendiumQuery
This is the query for searching summaries. 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 |
clearBalanceTerms()
Clears the balance terms.
|
void |
clearBudgetTerms()
Clears the budget terms.
|
void |
clearCreditsTerms()
Clears the credits terms.
|
void |
clearDebitsTerms()
Clears the debits terms.
|
void |
clearDeltaTerms()
Clears the delta terms.
|
void |
clearFiscalPeriodIdTerms()
Clears the fiscal period
Id query terms. |
void |
clearFiscalPeriodTerms()
Clears the fiscal period query terms.
|
void |
clearForecastTerms()
Clears the forecast terms.
|
AccountQuery |
getAccountQuery()
Gets the query for an account.
|
FiscalPeriodQuery |
getFiscalPeriodQuery()
Gets the query for a fiscal period.
|
SummaryQueryRecord |
getSummaryQueryRecord(Type summaryRecordType)
Gets the summary query record corresponding to the given
Summary record Type. |
void |
matchAccountId(Id accountId,
boolean match)
Matches an account
Id. |
void |
matchBalance(java.math.BigDecimal from,
java.math.BigDecimal to,
boolean match)
Matches summaries with a delta between debits and credits.
|
void |
matchBudget(Currency from,
Currency to,
boolean match)
Matches a budget within the given range inclusive.
|
void |
matchCredits(Currency from,
Currency to,
boolean match)
Matches credits within the given range inclusive.
|
void |
matchDebits(Currency from,
Currency to,
boolean match)
Matches debits within the given range inclusive.
|
void |
matchDelta(java.math.BigDecimal from,
java.math.BigDecimal to,
boolean match)
Matches summaries with a delta between the balance and the budget.
|
void |
matchFiscalPeriodId(Id fiscalPeriodId,
boolean match)
Sets the fiscal period
Id for this query. |
void |
matchForecast(Currency from,
Currency to,
boolean match)
Matches a forecast within the given range inclusive.
|
boolean |
supportsAccountQuery()
Tests if an
AccountQuery is available. |
boolean |
supportsFiscalPeriodQuery()
Tests if a
FiscalPeriodQuery is available. |
clearEndDateTerms, clearExtrapolatedTerms, clearInterpolatedTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchEndDate, matchExtrapolated, matchInterpolated, matchStartDate
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
void matchAccountId(Id accountId, boolean match)
Id.
accountId
- an account Id
match
- true
for 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 clearAccountTerms()
mandatory
- This method must be implemented. void matchFiscalPeriodId(Id fiscalPeriodId, boolean match)
Id
for this query.fiscalPeriodId
- a fiscal period Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- fiscalPeriodId
is null
mandatory
- This method must be implemented. void clearFiscalPeriodIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsFiscalPeriodQuery()
FiscalPeriodQuery
is available. true
if a fiscal period query is available,
false
otherwisemandatory
- This method must be implemented. FiscalPeriodQuery getFiscalPeriodQuery()
OR
term.UnimplementedException
-
supportsFiscalPeriodQuery()
is false
optional
- This method must be implemented if
supportsFiscalPeriodQuery()
is true.
void clearFiscalPeriodTerms()
mandatory
- This method must be implemented. void matchCredits(Currency from, Currency to, boolean match)
from
- start of rangeto
- end of rangematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void clearCreditsTerms()
mandatory
- This method must be implemented. void matchDebits(Currency from, Currency to, boolean match)
from
- start of rangeto
- end of rangematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void clearDebitsTerms()
mandatory
- This method must be implemented. void matchBalance(java.math.BigDecimal from, java.math.BigDecimal to, boolean match)
from
- start of rangeto
- end of rangematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
mandatory
- This method must be implemented. void clearBalanceTerms()
mandatory
- This method must be implemented. void matchBudget(Currency from, Currency to, boolean match)
from
- start of rangeto
- end of rangematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void clearBudgetTerms()
mandatory
- This method must be implemented. void matchDelta(java.math.BigDecimal from, java.math.BigDecimal to, boolean match)
from
- start of rangeto
- end of rangematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
mandatory
- This method must be implemented. void clearDeltaTerms()
mandatory
- This method must be implemented. void matchForecast(Currency from, Currency to, boolean match)
from
- start of rangeto
- end of rangematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void clearForecastTerms()
mandatory
- This method must be implemented. SummaryQueryRecord getSummaryQueryRecord(Type summaryRecordType) throws OperationFailedException
Summary
record Type.
Multiple record retrievals
produce a nested OR
term.summaryRecordType
- a summary record typeNullArgumentException
- summaryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(summaryRecordType)
is false
mandatory
- This method must be implemented.