org.osid.financials.budgeting

Interface BudgetQueryInspector

All Superinterfaces:

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

public interface BudgetQueryInspector
extends OsidObjectQueryInspector, OsidTemporalQueryInspector

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[]	getActivityIdTerms() Gets the activity Id query terms.
ActivityQueryInspector[]	getActivityTerms() Gets the activity query terms.
IdTerm[]	getBudgetEntryIdTerms() Gets the budget entry Id query terms.
BudgetEntryQueryInspector[]	getBudgetEntryTerms() Gets the budget entry query terms.
BudgetQueryInspectorRecord	getBudgetQueryInspectorRecord(Type budgetRecordType) Gets the budget query inspector record corresponding to the given Budget record Type.
IdTerm[]	getBusinessIdTerms() Gets the business Id query terms.
BusinessQueryInspector[]	getBusinessTerms() Gets the business query terms.
IdTerm[]	getFiscalPeriodIdTerms() Gets the fiscal period Id query terms.
FiscalPeriodQueryInspector[]	getFiscalPeriodTerms() Gets the fiscal period query terms.

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

getActivityIdTerms

IdTerm[] getActivityIdTerms()

Gets the activity Id query terms.

Returns:

the activity Id query terms

Compliance:

mandatory - This method must be implemented.

getActivityTerms

ActivityQueryInspector[] getActivityTerms()

Gets the activity query terms.

Returns:

the activity query 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.

getBudgetEntryIdTerms

IdTerm[] getBudgetEntryIdTerms()

Gets the budget entry Id query terms.

Returns:

the budget entry Id query terms

Compliance:

mandatory - This method must be implemented.

getBudgetEntryTerms

BudgetEntryQueryInspector[] getBudgetEntryTerms()

Gets the budget entry query terms.

Returns:

the budget entry 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.

getBudgetQueryInspectorRecord

BudgetQueryInspectorRecord getBudgetQueryInspectorRecord(Type budgetRecordType)
                                                         throws OperationFailedException

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

Parameters:

budgetRecordType - a budget record type

Returns:

the budget query inspector record

Throws:

NullArgumentException - budgetRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(budgetRecordType) is false

Compliance:

mandatory - This method must be implemented.