Interface ProgramQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector
public interface ProgramQueryInspector 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 query terms
      Compliance:
      mandatory - This method must be implemented.

    • getNumberTerms

      StringTerm[] getNumberTerms()
      Gets the bumber query terms.
      Returns:
      the number query 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.

    • getParentProgramIdTerms

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

    • getParentProgramTerms

      ProgramQueryInspector[] getParentProgramTerms()
      Gets the parent program query terms.
      Returns:
      the obective query terms
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectiveIdTerms

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

    • getLearningObjectiveTerms

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

    • getTargetAudienceIdTerms

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

    • getTargetAudienceTerms

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

    • getCompletionRequirementsInfoTerms

      StringTerm[] getCompletionRequirementsInfoTerms()
      Gets the completion requirements query terms.
      Returns:
      the prereq query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCompletionRequirementsIdTerms

      IdTerm[] getCompletionRequirementsIdTerms()
      Gets the completion requirements requisite Id query terms.
      Returns:
      the requisite Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCompletionRequirementsTerms

      RequisiteQueryInspector[] getCompletionRequirementsTerms()
      Gets the completion requirements requisite query terms.
      Returns:
      the requisite query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialIdTerms

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

    • getCredentialTerms

      CredentialQueryInspector[] getCredentialTerms()
      Gets the credential query terms.
      Returns:
      the grade system 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.

    • getProgramQueryInspectorRecord

      ProgramQueryInspectorRecord getProgramQueryInspectorRecord(Type programRecordType) throws OperationFailedException
      Gets the program query inspector record corresponding to the given Program record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      programRecordType - a program record type
      Returns:
      the program query inspector record
      Throws:
      NullArgumentException - programRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(programRecordType) is false
      Compliance:
      mandatory - This method must be implemented.