org.osid.financials

Interface SummaryQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCompendiumQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSubjugateableQuery, Suppliable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidCompendiumQuery

clearEndDateTerms, clearExtrapolatedTerms, clearInterpolatedTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchEndDate, matchExtrapolated, matchInterpolated, matchStartDate

Methods inherited from interface org.osid.OsidObjectQuery

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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Method Detail

matchAccountId

void matchAccountId(Id accountId,
                  boolean match)

Matches an account Id.

Parameters:

accountId - an account Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - accountId is null

Compliance:

mandatory - This method must be implemented.

clearAccountIdTerms

void clearAccountIdTerms()

Clears the account Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAccountQuery

boolean supportsAccountQuery()

Tests if an AccountQuery is available.

Returns:

true if an account query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAccountQuery

AccountQuery getAccountQuery()

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

Returns:

the account query

Throws:

UnimplementedException - supportsAccountQuery() is false

Compliance:

optional - This method must be implemented if supportsAccountQuery() is true.

clearAccountTerms

void clearAccountTerms()

Clears the account terms.

Compliance:

mandatory - This method must be implemented.

matchFiscalPeriodId

void matchFiscalPeriodId(Id fiscalPeriodId,
                       boolean match)

Sets the fiscal period Id for this query.

Parameters:

fiscalPeriodId - a fiscal period Id

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - fiscalPeriodId is null

Compliance:

mandatory - This method must be implemented.

clearFiscalPeriodIdTerms

void clearFiscalPeriodIdTerms()

Clears the fiscal period Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsFiscalPeriodQuery

boolean supportsFiscalPeriodQuery()

Tests if a FiscalPeriodQuery is available.

Returns:

true if a fiscal period query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodQuery

FiscalPeriodQuery getFiscalPeriodQuery()

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

Returns:

the fiscal period query

Throws:

UnimplementedException - supportsFiscalPeriodQuery() is false

Compliance:

optional - This method must be implemented if supportsFiscalPeriodQuery() is true.

clearFiscalPeriodTerms

void clearFiscalPeriodTerms()

Clears the fiscal period query terms.

Compliance:

mandatory - This method must be implemented.

matchCredits

void matchCredits(Currency from,
                Currency to,
                boolean match)

Matches credits within the given range inclusive.

Parameters:

from - start of range

to - end of range

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

clearCreditsTerms

void clearCreditsTerms()

Clears the credits terms.

Compliance:

mandatory - This method must be implemented.

matchDebits

void matchDebits(Currency from,
               Currency to,
               boolean match)

Matches debits within the given range inclusive.

Parameters:

from - start of range

to - end of range

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

clearDebitsTerms

void clearDebitsTerms()

Clears the debits terms.

Compliance:

mandatory - This method must be implemented.

matchBalance

void matchBalance(java.math.BigDecimal from,
                java.math.BigDecimal to,
                boolean match)

Matches summaries with a delta between debits and credits.

Parameters:

from - start of range

to - end of range

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

Compliance:

mandatory - This method must be implemented.

clearBalanceTerms

void clearBalanceTerms()

Clears the balance terms.

Compliance:

mandatory - This method must be implemented.

matchBudget

void matchBudget(Currency from,
               Currency to,
               boolean match)

Matches a budget within the given range inclusive.

Parameters:

from - start of range

to - end of range

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

clearBudgetTerms

void clearBudgetTerms()

Clears the budget terms.

Compliance:

mandatory - This method must be implemented.

matchDelta

void matchDelta(java.math.BigDecimal from,
              java.math.BigDecimal to,
              boolean match)

Matches summaries with a delta between the balance and the budget.

Parameters:

from - start of range

to - end of range

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

Compliance:

mandatory - This method must be implemented.

clearDeltaTerms

void clearDeltaTerms()

Clears the delta terms.

Compliance:

mandatory - This method must be implemented.

matchForecast

void matchForecast(Currency from,
                 Currency to,
                 boolean match)

Matches a forecast within the given range inclusive.

Parameters:

from - start of range

to - end of range

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

clearForecastTerms

void clearForecastTerms()

Clears the forecast terms.

Compliance:

mandatory - This method must be implemented.

getSummaryQueryRecord

SummaryQueryRecord getSummaryQueryRecord(Type summaryRecordType)
                                         throws OperationFailedException

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

Parameters:

summaryRecordType - a summary record type

Returns:

the summary query record

Throws:

NullArgumentException - summaryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(summaryRecordType) is false

Compliance:

mandatory - This method must be implemented.