Interface ActivityQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidSubjugateableQueryInspector, OsidTemporalQueryInspector
public interface ActivityQueryInspector extends OsidRelationshipQueryInspector, 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

    • getImplicitTerms

      BooleanTerm[] getImplicitTerms()
      Gets the implicit terms.
      Returns:
      the implicit 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.

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

    • getMeetingTimeTerms

      DateTimeTerm[] getMeetingTimeTerms()
      Gets the meeting time query terms.
      Returns:
      the date query terms
      Compliance:
      mandatory - This method must be implemented.

    • getMeetingTimeInclusiveTerms

      DateTimeRangeTerm[] getMeetingTimeInclusiveTerms()
      Gets the meeting time query terms.
      Returns:
      the date range query terms
      Compliance:
      mandatory - This method must be implemented.

    • getMeetingLocationIdTerms

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

    • getMeetingLocationTerms

      LocationQueryInspector[] getMeetingLocationTerms()
      Gets the location query terms.
      Returns:
      the location query terms
      Compliance:
      mandatory - This method must be implemented.

    • getScheduleIdTerms

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

    • getScheduleTerms

      ScheduleQueryInspector[] getScheduleTerms()
      Gets the schedule query terms.
      Returns:
      the schedule query terms
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingActivityIdTerms

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

    • getSupersedingActivityTerms

      ActivityQueryInspector[] getSupersedingActivityTerms()
      Gets the superseding activity query terms.
      Returns:
      the activity query terms
      Compliance:
      mandatory - This method must be implemented.

    • getSpecificMeetingTimeTerms

      DateTimeRangeTerm[] getSpecificMeetingTimeTerms()
      Gets the specific meeting time query terms.
      Returns:
      the date range query terms
      Compliance:
      mandatory - This method must be implemented.

    • getBlackoutTerms

      DateTimeTerm[] getBlackoutTerms()
      Gets the blackout query terms.
      Returns:
      the blackout query terms
      Compliance:
      mandatory - This method must be implemented.

    • getBlackoutInclusiveTerms

      DateTimeRangeTerm[] getBlackoutInclusiveTerms()
      Gets the inclusive blackout query terms.
      Returns:
      the blackout query terms
      Compliance:
      mandatory - This method must be implemented.

    • getInstructorIdTerms

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

    • getInstructorTerms

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

    • getMinimumSeatsTerms

      CardinalRangeTerm[] getMinimumSeatsTerms()
      Gets the minimum seating terms.
      Returns:
      the minimum seat query terms
      Compliance:
      mandatory - This method must be implemented.

    • getMaximumSeatsTerms

      CardinalRangeTerm[] getMaximumSeatsTerms()
      Gets the maximum seating terms.
      Returns:
      the maximum seat 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.

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

    • getActivityQueryInspectorRecord

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