Interface CatalogueQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector
public interface CatalogueQueryInspector 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

    • getCanonicalUnitIdTerms

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

    • getCanonicalUnitTerms

      CanonicalUnitQueryInspector[] getCanonicalUnitTerms()
      Gets the canonical unit query terms.
      Returns:
      the canonical unit terms
      Compliance:
      mandatory - This method must be implemented.

    • getOfferingIdTerms

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

    • getOfferingTerms

      OfferingQueryInspector[] getOfferingTerms()
      Gets the offering query terms.
      Returns:
      the offering terms
      Compliance:
      mandatory - This method must be implemented.

    • getParticipantIdTerms

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

    • getParticipantTerms

      ParticipantQueryInspector[] getParticipantTerms()
      Gets the participant query terms.
      Returns:
      the participant terms
      Compliance:
      mandatory - This method must be implemented.

    • getResultIdTerms

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

    • getResultTerms

      ResultQueryInspector[] getResultTerms()
      Gets the result query terms.
      Returns:
      the result terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorCatalogueIdTerms

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

    • getAncestorCatalogueTerms

      CatalogueQueryInspector[] getAncestorCatalogueTerms()
      Gets the ancestor catalogue query terms.
      Returns:
      the ancestor catalogue terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantCatalogueIdTerms

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

    • getDescendantCatalogueTerms

      CatalogueQueryInspector[] getDescendantCatalogueTerms()
      Gets the descendant catalogue query terms.
      Returns:
      the descendant catalogue terms
      Compliance:
      mandatory - This method must be implemented.

    • getCatalogueQueryInspectorRecord

      CatalogueQueryInspectorRecord getCatalogueQueryInspectorRecord(Type catalogueRecordType) throws OperationFailedException
      Gets the record query inspector record corresponding to the given Catalogue record Type .
      Parameters:
      catalogueRecordType - a catalogue record type
      Returns:
      the catalogue query inspector record
      Throws:
      NullArgumentException - catalogueRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(catalogueRecordType) is false
      Compliance:
      mandatory - This method must be implemented.