Interface BudgetEntryQueryInspector
- All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, 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
Modifier and TypeMethodDescriptionIdTerm[]Gets the accountIdquery terms.Gets the account query terms.Gets the amount query terms.getBudgetEntryQueryInspectorRecord(Type budgetEntryRecordType) Gets the budget entry query inspector record corresponding to the givenBudgetEntryrecordType.IdTerm[]Gets the budgetIdquery terms.Gets the budget query terms.IdTerm[]Gets the businessIdquery terms.Gets the business query terms.Gets the debit query terms.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface OsidExtensibleQueryInspector
getRecordTypeTermsMethods inherited from interface OsidIdentifiableQueryInspector
getIdTermsMethods inherited from interface OsidObjectQueryInspector
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTermsModifier and TypeMethodDescriptionIdTerm[]Gets the commentIdquery terms.Gets the comment query terms.IdTerm[]Gets the creditIdquery terms.Gets the credit query terms.Gets the description query terms.Gets the display name query terms.TypeTerm[]Gets the genus type query terms.IdTerm[]Gets the journal entryIdquery terms.Gets the journal entry query terms.TypeTerm[]Gets the parent genus type query terms.IdTerm[]Gets the relationshipIdquery terms.IdTerm[]Gets the relationship peerIdquery terms.Gets the relationship query terms.IdTerm[]Gets the stateIdquery terms.Gets the state query terms.Gets the statistic query terms.IdTerm[]Gets the subjectIdquery terms.Gets the subject relevancy query terms.Gets the subject query terms.Methods inherited from interface OsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.Methods inherited from interface OsidRelationshipQueryInspector
getEndReasonIdTerms, getEndReasonTermsModifier and TypeMethodDescriptionIdTerm[]Gets the end reaosn stateIdquery terms.Gets the end reaosn state query terms.Methods inherited from interface OsidTemporalQueryInspector
getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTermsModifier and TypeMethodDescriptionGets the date query terms.Gets the effective query terms.Gets the end date query terms.Gets the start date query terms.
-
Method Details
-
getBudgetIdTerms
IdTerm[] getBudgetIdTerms()Gets the budgetIdquery terms.- Returns:
- the v
Idquery 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 accountIdquery terms.- Returns:
- the account
Idquery 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 businessIdquery terms.- Returns:
- the business
Idquery 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 givenBudgetEntryrecordType. Multiple record retrievals produce a nestedORterm.- Parameters:
budgetEntryRecordType- a budget entry record type- Returns:
- the budget entry query inspector record
- Throws:
NullArgumentException-budgetEntryRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(budgetEntryRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-