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

Modifier and Type	Method	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 .Multiple record retrievals produce a nested OR term.
void	matchAccountId(Id accountId, boolean match)	Matches an account Id .
void	matchBalance(BigDecimal from, 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(BigDecimal from, 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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidCompendiumQuery

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

Modifier and Type	Method	Description
void	clearEndDateTerms()	Clears the end date query terms.
void	clearExtrapolatedTerms()	Clears the extrapolated query terms.
void	clearInterpolatedTerms()	Clears the interpolated query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches reports with any end date set.
void	matchAnyStartDate(boolean match)	Matches reports with any start date set.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches reports whose effective end date falls in between the given dates inclusive.
void	matchExtrapolated(boolean match)	Match reports that are extrapolated.
void	matchInterpolated(boolean match)	Match reports that are interpolated.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches reports whose start date falls in between the given dates inclusive.

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

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 {@code supportsAccountQuery()} is {@code 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 {@code supportsFiscalPeriodQuery()} is {@code 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(BigDecimal from,
 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(BigDecimal from,
 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.