Interface CanonicalUnitQueryInspector

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

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

    • getTitleTerms

      StringTerm[] getTitleTerms()
      Gets the title query terms.
      Returns:
      the title terms
      Compliance:
      mandatory - This method must be implemented.

    • getCodeTerms

      StringTerm[] getCodeTerms()
      Gets the code query terms.
      Returns:
      the code terms
      Compliance:
      mandatory - This method must be implemented.

    • getOfferedCyclicTimePeriodIdTerms

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

    • getOfferedCyclicTimePeriodTerms

      CyclicTimePeriodQueryInspector[] getOfferedCyclicTimePeriodTerms()
      Gets the offered cyclic time period query terms.
      Returns:
      the cyclic time period terms
      Compliance:
      mandatory - This method must be implemented.

    • getResultOptionIdTerms

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

    • getResultOptionTerms

      GradeSystemQueryInspector[] getResultOptionTerms()
      Gets the grade system query terms.
      Returns:
      the grade system terms
      Compliance:
      mandatory - This method must be implemented.

    • getSponsorIdTerms

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

    • getSponsorTerms

      ResourceQueryInspector[] getSponsorTerms()
      Gets the sponsor query terms.
      Returns:
      the sponsor query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCatalogueIdTerms

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

    • getCatalogueTerms

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

    • getCanonicalUnitQueryInspectorRecord

      CanonicalUnitQueryInspectorRecord getCanonicalUnitQueryInspectorRecord(Type canonicalUnitRecordType) throws OperationFailedException
      Gets the canonical unit query inspector record corresponding to the given CanonicalUnit record Type .
      Parameters:
      canonicalUnitRecordType - a canonical unit record type
      Returns:
      the canonical unit inspector query record
      Throws:
      NullArgumentException - canonicalUnitRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(canonicalUnitRecordType) is false
      Compliance:
      mandatory - This method must be implemented.