Interface BudgetQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector
public interface BudgetQueryInspector 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 Details

    • 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.