Interface CourseCatalogQueryInspector

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

    • getCourseIdTerms

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

    • getCourseTerms

      CourseQueryInspector[] getCourseTerms()
      Gets the course query terms.
      Returns:
      the course query terms
      Compliance:
      mandatory - This method must be implemented.

    • getActivityUnitIdTerms

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

    • getActivityUnitTerms

      ActivityUnitQueryInspector[] getActivityUnitTerms()
      Gets the activity unit query terms.
      Returns:
      the activity unit query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCourseOfferingIdTerms

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

    • getCourseOfferingTerms

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

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

    • getTermIdTerms

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

    • getTermTerms

      TermQueryInspector[] getTermTerms()
      Gets the term query terms.
      Returns:
      the term query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorCourseCatalogIdTerms

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

    • getAncestorCourseCatalogTerms

      CourseCatalogQueryInspector[] getAncestorCourseCatalogTerms()
      Gets the ancestor course catalog query terms.
      Returns:
      the ancestor course catalog terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantCourseCatalogIdTerms

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

    • getDescendantCourseCatalogTerms

      CourseCatalogQueryInspector[] getDescendantCourseCatalogTerms()
      Gets the descendant course catalog query terms.
      Returns:
      the descendant course catalog terms
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogQueryInspectorRecord

      CourseCatalogQueryInspectorRecord getCourseCatalogQueryInspectorRecord(Type courseCatalogRecordType) throws OperationFailedException
      Gets the course catalog query inspector record corresponding to the given CourseCatalog record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      courseCatalogRecordType - a course catalog record type
      Returns:
      the course catalog query inspector record
      Throws:
      NullArgumentException - courseCatalogRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(courseCatalogRecordType) is false
      Compliance:
      mandatory - This method must be implemented.