Interface BusinessQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector
public interface BusinessQueryInspector extends OsidCatalogQueryInspector

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

    • getCustomerIdTerms

      IdTerm[] getCustomerIdTerms()
      Gets the customer Id query terms.
      Returns:
      the customer Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCustomerTerms

      CustomerQueryInspector[] getCustomerTerms()
      Gets the customer query terms.
      Returns:
      the customer query terms
      Compliance:
      mandatory - This method must be implemented.

    • getItemIdTerms

      IdTerm[] getItemIdTerms()
      Gets the item Id query terms.
      Returns:
      the item Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getItemTerms

      ItemQueryInspector[] getItemTerms()
      Gets the item query terms.
      Returns:
      the item query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCategoryIdTerms

      IdTerm[] getCategoryIdTerms()
      Gets the category Id query terms.
      Returns:
      the category Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCategoryTerms

      CategoryQueryInspector[] getCategoryTerms()
      Gets the category query terms.
      Returns:
      the category query terms
      Compliance:
      mandatory - This method must be implemented.

    • getEntryIdTerms

      IdTerm[] getEntryIdTerms()
      Gets the entry Id query terms.
      Returns:
      the entry Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getEntryTerms

      EntryQueryInspector[] getEntryTerms()
      Gets the entry query terms.
      Returns:
      the entry query terms
      Compliance:
      mandatory - This method must be implemented.

    • getPeriodIdTerms

      IdTerm[] getPeriodIdTerms()
      Gets the period Id query terms.
      Returns:
      the period Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getPeriodTerms

      PeriodQueryInspector[] getPeriodTerms()
      Gets the period query terms.
      Returns:
      the period query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorBusinessIdTerms

      IdTerm[] getAncestorBusinessIdTerms()
      Gets the ancestor business Id query terms.
      Returns:
      the ancestor business Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorBusinessTerms

      BusinessQueryInspector[] getAncestorBusinessTerms()
      Gets the ancestor business query terms.
      Returns:
      the ancestor business terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantBusinessIdTerms

      IdTerm[] getDescendantBusinessIdTerms()
      Gets the descendant business Id query terms.
      Returns:
      the descendant business Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantBusinessTerms

      BusinessQueryInspector[] getDescendantBusinessTerms()
      Gets the descendant business query terms.
      Returns:
      the descendant business terms
      Compliance:
      mandatory - This method must be implemented.

    • getBusinessQueryInspectorRecord

      BusinessQueryInspectorRecord getBusinessQueryInspectorRecord(Type businessRecordType) throws OperationFailedException
      Gets the business query inspector record corresponding to the given Business record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      businessRecordType - a business record type
      Returns:
      the business query inspector record
      Throws:
      NullArgumentException - businessRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(businessRecordType) is false
      Compliance:
      mandatory - This method must be implemented.