Interface EntryQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector
public interface EntryQueryInspector extends OsidObjectQueryInspector

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

  • Method Details

    • getKeyTypeTerms

      TypeTerm[] getKeyTypeTerms()
      Gets the key type query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getKeyTerms

      ObjectTerm[] getKeyTerms()
      Gets the key query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getValueTypeTerms

      TypeTerm[] getValueTypeTerms()
      Gets the value type query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getValueTerms

      ObjectTerm[] getValueTerms()
      Gets the value query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getDictionaryIdTerms

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

    • getDictionaryTerms

      DictionaryQueryInspector[] getDictionaryTerms()
      Gets the dictionary query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getEntryQueryInspectorRecord

      EntryQueryInspectorRecord getEntryQueryInspectorRecord(Type entryRecordType) throws OperationFailedException
      Gets the entry query inspector record corresponding to the given Entry record Type .
      Parameters:
      entryRecordType - an entry record type
      Returns:
      the entry query inspector record
      Throws:
      NullArgumentException - entryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(entryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.