org.osid.financials

Interface SummaryQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCompendiumQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSubjugateableQueryInspector

public interface SummaryQueryInspector
extends OsidCompendiumQueryInspector

The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to OsidQuery interfaces for reuse or modification in the search sessions.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAccountIdTerms() Gets the account Id query terms.
AccountQueryInspector[]	getAccountTerms() Gets the account query terms.
DecimalRangeTerm[]	getBalanceTerms() Gets the balacnce query terms.
CurrencyRangeTerm[]	getBudgetTerms() Gets the budget query terms.
CurrencyRangeTerm[]	getCreditsTerms() Gets the credits query terms.
CurrencyRangeTerm[]	getDebitsTerms() Gets the debits query terms.
DecimalRangeTerm[]	getDeltaTerms() Gets the delta query terms.
IdTerm[]	getFiscalPeriodIdTerms() Gets the fiscal period Id query terms.
FiscalPeriodQueryInspector[]	getFiscalPeriodTerms() Gets the fiscal period query terms.
CurrencyRangeTerm[]	getForecastTerms() Gets the forecast query terms.
SummaryQueryInspectorRecord	getSummaryQueryInspectorRecord(Type summaryRecordType) Gets the summary query inspector record corresponding to the given Summary record Type.

Methods inherited from interface org.osid.OsidCompendiumQueryInspector

getEndDateTerms, getExtrapolatedTerms, getInterpolatedTerms, getStartDateTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Method Detail

getAccountIdTerms

IdTerm[] getAccountIdTerms()

Gets the account Id query terms.

Returns:

the account Id terms

Compliance:

mandatory - This method must be implemented.

getAccountTerms

AccountQueryInspector[] getAccountTerms()

Gets the account query terms.

Returns:

the account terms

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodIdTerms

IdTerm[] getFiscalPeriodIdTerms()

Gets the fiscal period Id query terms.

Returns:

the fiscal period Id query terms

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodTerms

FiscalPeriodQueryInspector[] getFiscalPeriodTerms()

Gets the fiscal period query terms.

Returns:

the fiscal period query terms

Compliance:

mandatory - This method must be implemented.

getCreditsTerms

CurrencyRangeTerm[] getCreditsTerms()

Gets the credits query terms.

Returns:

the credits query terms

Compliance:

mandatory - This method must be implemented.

getDebitsTerms

CurrencyRangeTerm[] getDebitsTerms()

Gets the debits query terms.

Returns:

the debits query terms

Compliance:

mandatory - This method must be implemented.

getBalanceTerms

DecimalRangeTerm[] getBalanceTerms()

Gets the balacnce query terms.

Returns:

the balance query terms

Compliance:

mandatory - This method must be implemented.

getBudgetTerms

CurrencyRangeTerm[] getBudgetTerms()

Gets the budget query terms.

Returns:

the budget query terms

Compliance:

mandatory - This method must be implemented.

getDeltaTerms

DecimalRangeTerm[] getDeltaTerms()

Gets the delta query terms.

Returns:

the delta query terms

Compliance:

mandatory - This method must be implemented.

getForecastTerms

CurrencyRangeTerm[] getForecastTerms()

Gets the forecast query terms.

Returns:

the forecast query terms

Compliance:

mandatory - This method must be implemented.

getSummaryQueryInspectorRecord

SummaryQueryInspectorRecord getSummaryQueryInspectorRecord(Type summaryRecordType)
                                                           throws OperationFailedException

Gets the summary query inspector 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 inspector record

Throws:

NullArgumentException - summaryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(summaryRecordType) is false

Compliance:

mandatory - This method must be implemented.