Interface DocetQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface DocetQueryInspector extends OsidRelationshipQueryInspector

This is the query inspector for searching for docets. Each method specifies an AND term while multiple invocations of the same method produce a nested OR .

  • Method Details

    • getModuleIdTerms

      IdTerm[] getModuleIdTerms()
      Gets the module Id terms.
      Returns:
      the module Id terms
      Compliance:
      mandatory - This method must be implemented.
    • getModuleTerms

      ModuleQueryInspector[] getModuleTerms()
      Gets the module terms.
      Returns:
      the module terms
      Compliance:
      mandatory - This method must be implemented.
    • getActivityUnitIdTerms

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

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

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

      ObjectiveQueryInspector[] getLearningObjectiveTerms()
      Gets the objective query terms.
      Returns:
      the objective terms
      Compliance:
      mandatory - This method must be implemented.
    • getInClassTerms

      BooleanTerm[] getInClassTerms()
      Gets the in class query terms.
      Returns:
      the in class query terms
      Compliance:
      mandatory - This method must be implemented.
    • getDurationTerms

      DurationRangeTerm[] getDurationTerms()
      Gets the duration query terms.
      Returns:
      the duration query terms
      Compliance:
      mandatory - This method must be implemented.
    • getAssetIdTerms

      IdTerm[] getAssetIdTerms()
      Gets the asset Id query terms.
      Returns:
      the asset Id terms
      Compliance:
      mandatory - This method must be implemented.
    • getAssetTerms

      AssetQueryInspector[] getAssetTerms()
      Gets the asset query terms.
      Returns:
      the asset terms
      Compliance:
      mandatory - This method must be implemented.
    • getAssessmentIdTerms

      IdTerm[] getAssessmentIdTerms()
      Gets the asset Id query terms.
      Returns:
      the asset Id terms
      Compliance:
      mandatory - This method must be implemented.
    • getAssessmentTerms

      AssetQueryInspector[] getAssessmentTerms()
      Gets the asset query terms.
      Returns:
      the asset terms
      Compliance:
      mandatory - This method must be implemented.
    • getCourseCatalogIdTerms

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

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

      DocetQueryInspectorRecord getDocetQueryInspectorRecord(Type docetRecordType) throws OperationFailedException
      Gets the query inspector record corresponding to the given Docet record Type .
      Parameters:
      docetRecordType - a docet record type
      Returns:
      the docet query inspector record
      Throws:
      NullArgumentException - docetRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(docetRecordType) is false
      Compliance:
      mandatory - This method must be implemented.