Interface OsidRequestQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector
All Known Subinterfaces:
RegistrationRequestQueryInspector
public interface OsidRequestQueryInspector extends OsidObjectQueryInspector

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 an OsidQuery for reuse or modification in the search sessions.

  • Method Details

    • getPostingDateTerms

      DateTimeRangeTerm[] getPostingDateTerms()
      Gets the posting date query terms.
      Returns:
      the posting date terms
      Compliance:
      mandatory - This method must be implemented.

    • getRequesterIdTerms

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

    • getRequesterTerms

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

    • getSubmittedTerms

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

    • getSubmittedDateTerms

      DateTimeRangeTerm[] getSubmittedDateTerms()
      Gets the submitted date query terms.
      Returns:
      the submitted date terms
      Compliance:
      mandatory - This method must be implemented.

    • getSubmitterIdTerms

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

    • getSubmitterTerms

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

    • getSubmittingAgentIdTerms

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

    • getSubmittingAgentTerms

      AgentQueryInspector[] getSubmittingAgentTerms()
      Gets the agent query terms.
      Returns:
      the agent query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCanceledTerms

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

    • getProcessedDateTerms

      DateTimeRangeTerm[] getProcessedDateTerms()
      Gets the processed date query terms.
      Returns:
      the processed date terms
      Compliance:
      mandatory - This method must be implemented.

    • getErrorIdTerms

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

    • getErrorTerms

      StateQueryInspector[] getErrorTerms()
      Gets the state query terms.
      Returns:
      the state query terms
      Compliance:
      mandatory - This method must be implemented.