Interface BankQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector
public interface BankQueryInspector extends OsidCatalogQueryInspector

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

    • getItemIdTerms

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

    • getItemTerms

      ItemQueryInspector[] getItemTerms()
      Gets the item query terms.
      Returns:
      the item query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentIdTerms

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

    • getAssessmentTerms

      AssessmentQueryInspector[] getAssessmentTerms()
      Gets the assessment query terms.
      Returns:
      the assessment terms
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentOfferedIdTerms

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

    • getAssessmentOfferedTerms

      AssessmentOfferedQueryInspector[] getAssessmentOfferedTerms()
      Gets the assessment offered query terms.
      Returns:
      the assessment offered terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorBankIdTerms

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

    • getAncestorBankTerms

      BankQueryInspector[] getAncestorBankTerms()
      Gets the ancestor bank query terms.
      Returns:
      the ancestor bank terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantBankIdTerms

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

    • getDescendantBankTerms

      BankQueryInspector[] getDescendantBankTerms()
      Gets the descendant bank query terms.
      Returns:
      the descendant bank terms
      Compliance:
      mandatory - This method must be implemented.

    • getBankQueryInspectorRecord

      BankQueryInspectorRecord getBankQueryInspectorRecord(Type bankRecordType) throws OperationFailedException
      Gets the bank query inspector record corresponding to the given Bank record Type .
      Parameters:
      bankRecordType - a bank record type
      Returns:
      the bank query inspector record
      Throws:
      NullArgumentException - bankRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(bankRecordType) is false
      Compliance:
      mandatory - This method must be implemented.