Interface CategoryQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector
public interface CategoryQueryInspector extends OsidObjectQueryInspector

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

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

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

    • getCategoryQueryInspectorRecord

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