Interface ActivityUnitQueryInspector

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

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.

    • getTotalTargetEffortTerms

      DurationRangeTerm[] getTotalTargetEffortTerms()
      Gets the total effort query terms.
      Returns:
      the total effort query terms
      Compliance:
      mandatory - This method must be implemented.

    • getContactTerms

      BooleanTerm[] getContactTerms()
      Gets the contact query terms.
      Returns:
      the contact query terms
      Compliance:
      mandatory - This method must be implemented.

    • getTotalTargetContactTimeTerms

      DurationRangeTerm[] getTotalTargetContactTimeTerms()
      Gets the total contact time query terms.
      Returns:
      the total contact time query terms
      Compliance:
      mandatory - This method must be implemented.

    • getTotalTargetIndividualEffortTerms

      DurationRangeTerm[] getTotalTargetIndividualEffortTerms()
      Gets the total individual effort query terms.
      Returns:
      the total individual effort query terms
      Compliance:
      mandatory - This method must be implemented.

    • getRecurringWeeklyTerms

      BooleanTerm[] getRecurringWeeklyTerms()
      Gets the recurring weekly query terms.
      Returns:
      the recurring weekly query terms
      Compliance:
      mandatory - This method must be implemented.

    • getWeeklyEffortTerms

      DurationRangeTerm[] getWeeklyEffortTerms()
      Gets the weekly effort query terms.
      Returns:
      the weekly effort query terms
      Compliance:
      mandatory - This method must be implemented.

    • getWeeklyContactTimeTerms

      DurationRangeTerm[] getWeeklyContactTimeTerms()
      Gets the weekly contact time query terms.
      Returns:
      the weekly contact time query terms
      Compliance:
      mandatory - This method must be implemented.

    • getWeeklyIndividualEffortTerms

      DurationRangeTerm[] getWeeklyIndividualEffortTerms()
      Gets the weekly individual effort query terms.
      Returns:
      the weekly individual effort query terms
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectiveIdTerms

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

    • getLearningObjectiveTerms

      ObjectiveQueryInspector[] getLearningObjectiveTerms()
      Gets the objective query terms.
      Returns:
      the objective 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.

    • getCourseCatalogIdTerms

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

    • getCourseCatalogTerms

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

    • getActivityUnitQueryInspectorRecord

      ActivityUnitQueryInspectorRecord getActivityUnitQueryInspectorRecord(Type activityUnitRecordType) throws OperationFailedException
      Gets the activity unit query inspector record corresponding to the given ActivityUnit record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      activityUnitRecordType - an activity unit record type
      Returns:
      the activity unit query inspector record
      Throws:
      NullArgumentException - activityUnitRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(activityUnitRecordType) is false
      Compliance:
      mandatory - This method must be implemented.