org.osid.financials.budgeting

Interface BudgetEntryQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface BudgetEntryQueryInspector
extends OsidRelationshipQueryInspector

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.
CurrencyRangeTerm[]	getAmountTerms() Gets the amount query terms.
BudgetEntryQueryInspectorRecord	getBudgetEntryQueryInspectorRecord(Type budgetEntryRecordType) Gets the budget entry query inspector record corresponding to the given BudgetEntry record Type.
IdTerm[]	getBudgetIdTerms() Gets the budget Id query terms.
BudgetQueryInspector[]	getBudgetTerms() Gets the budget query terms.
IdTerm[]	getBusinessIdTerms() Gets the business Id query terms.
BusinessQueryInspector[]	getBusinessTerms() Gets the business query terms.
BooleanTerm[]	getDebitTerms() Gets the debit query terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

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

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getBudgetIdTerms

IdTerm[] getBudgetIdTerms()

Gets the budget Id query terms.

Returns:

the v Id query terms

Compliance:

mandatory - This method must be implemented.

getBudgetTerms

BudgetQueryInspector[] getBudgetTerms()

Gets the budget query terms.

Returns:

the budget query terms

Compliance:

mandatory - This method must be implemented.

getAccountIdTerms

IdTerm[] getAccountIdTerms()

Gets the account Id query terms.

Returns:

the account Id query terms

Compliance:

mandatory - This method must be implemented.

getAccountTerms

AccountQueryInspector[] getAccountTerms()

Gets the account query terms.

Returns:

the account query terms

Compliance:

mandatory - This method must be implemented.

getAmountTerms

CurrencyRangeTerm[] getAmountTerms()

Gets the amount query terms.

Returns:

the date range query terms

Compliance:

mandatory - This method must be implemented.

getDebitTerms

BooleanTerm[] getDebitTerms()

Gets the debit query terms.

Returns:

the debit query terms

Compliance:

mandatory - This method must be implemented.

getBusinessIdTerms

IdTerm[] getBusinessIdTerms()

Gets the business Id query terms.

Returns:

the business Id query terms

Compliance:

mandatory - This method must be implemented.

getBusinessTerms

BusinessQueryInspector[] getBusinessTerms()

Gets the business query terms.

Returns:

the business query terms

Compliance:

mandatory - This method must be implemented.

getBudgetEntryQueryInspectorRecord

BudgetEntryQueryInspectorRecord getBudgetEntryQueryInspectorRecord(Type budgetEntryRecordType)
                                                                   throws OperationFailedException

Gets the budget entry query inspector record corresponding to the given BudgetEntry record Type. Multiple record retrievals produce a nested OR term.

Parameters:

budgetEntryRecordType - a budget entry record type

Returns:

the budget entry query inspector record

Throws:

NullArgumentException - budgetEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(budgetEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.