Interface BankQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable
public interface BankQuery extends OsidCatalogQuery

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

  • Method Details

    • matchItemId

      void matchItemId(Id itemId, boolean match)
      Sets the item Id for this query.
      Parameters:
      itemId - an item Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - itemId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearItemIdTerms

      void clearItemIdTerms()
      Clears all item Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemQuery

      boolean supportsItemQuery()
      Tests if a ItemQuery is available.
      Returns:
      true if an item query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getItemQuery

      ItemQuery getItemQuery()
      Gets the query for an item. Multiple retrievals produce a nested OR term.
      Returns:
      the item query
      Throws:
      UnimplementedException - supportsItemQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsItemQuery()} is {@code true} .

    • matchAnyItem

      void matchAnyItem(boolean match)
      Matches assessment banks that have any item assigned.
      Parameters:
      match - true to match banks with any item, false to match assessments with no item
      Compliance:
      mandatory - This method must be implemented.

    • clearItemTerms

      void clearItemTerms()
      Clears all item terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAssessmentId

      void matchAssessmentId(Id assessmentId, boolean match)
      Sets the assessment Id for this query.
      Parameters:
      assessmentId - an assessment Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - assessmentId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAssessmentIdTerms

      void clearAssessmentIdTerms()
      Clears all assessment Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAssessmentQuery

      boolean supportsAssessmentQuery()
      Tests if an AssessmentQuery is available.
      Returns:
      true if an assessment query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentQuery

      AssessmentQuery getAssessmentQuery()
      Gets the query for an assessment. Multiple retrievals produce a nested OR term.
      Returns:
      the assessment query
      Throws:
      UnimplementedException - supportsAssessmentQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAssessmentQuery()} is {@code true} .

    • matchAnyAssessment

      void matchAnyAssessment(boolean match)
      Matches assessment banks that have any assessment assigned.
      Parameters:
      match - true to match banks with any assessment, false to match banks with no assessment
      Compliance:
      mandatory - This method must be implemented.

    • clearAssessmentTerms

      void clearAssessmentTerms()
      Clears all assessment terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAssessmentOfferedId

      void matchAssessmentOfferedId(Id assessmentOfferedId, boolean match)
      Sets the assessment offered Id for this query.
      Parameters:
      assessmentOfferedId - an assessment Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - assessmentOfferedId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAssessmentOfferedIdTerms

      void clearAssessmentOfferedIdTerms()
      Clears all assessment offered Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAssessmentOfferedQuery

      boolean supportsAssessmentOfferedQuery()
      Tests if an AssessmentOfferedQuery is available.
      Returns:
      true if an assessment offered query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentOfferedQuery

      AssessmentOfferedQuery getAssessmentOfferedQuery()
      Gets the query for an assessment offered. Multiple retrievals produce a nested OR term.
      Returns:
      the assessment offered query
      Throws:
      UnimplementedException - supportsAssessmentOfferedQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAssessmentOfferedQuery()} is {@code true} .

    • matchAnyAssessmentOffered

      void matchAnyAssessmentOffered(boolean match)
      Matches assessment banks that have any assessment offering assigned.
      Parameters:
      match - true to match banks with any assessment offering, false to match banks with no offering
      Compliance:
      mandatory - This method must be implemented.

    • clearAssessmentOfferedTerms

      void clearAssessmentOfferedTerms()
      Clears all assessment offered terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAncestorBankId

      void matchAncestorBankId(Id bankId, boolean match)
      Sets the bank Id for to match banks in which the specified bank is an acestor.
      Parameters:
      bankId - a bank Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - bankId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAncestorBankIdTerms

      void clearAncestorBankIdTerms()
      Clears all ancestor bank Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAncestorBankQuery

      boolean supportsAncestorBankQuery()
      Tests if a BankQuery is available.
      Returns:
      true if a bank query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorBankQuery

      BankQuery getAncestorBankQuery()
      Gets the query for an ancestor bank. Multiple retrievals produce a nested OR term.
      Returns:
      the bank query
      Throws:
      UnimplementedException - supportsAncestorBankQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAncestorBankQuery()} is {@code true} .

    • matchAnyAncestorBank

      void matchAnyAncestorBank(boolean match)
      Matches a bank that has any ancestor.
      Parameters:
      match - true to match banks with any ancestor banks, false to match root banks
      Compliance:
      mandatory - This method must be implemented.

    • clearAncestorBankTerms

      void clearAncestorBankTerms()
      Clears all ancestor bank terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDescendantBankId

      void matchDescendantBankId(Id bankId, boolean match)
      Sets the bank Id for to match banks in which the specified bank is a descendant.
      Parameters:
      bankId - a bank Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - bankId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearDescendantBankIdTerms

      void clearDescendantBankIdTerms()
      Clears all descendant bank Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsDescendantBankQuery

      boolean supportsDescendantBankQuery()
      Tests if a BankQuery is available.
      Returns:
      true if a bank query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantBankQuery

      BankQuery getDescendantBankQuery()
      Gets the query for a descendant bank. Multiple retrievals produce a nested OR term.
      Returns:
      the bank query
      Throws:
      UnimplementedException - supportsDescendantBankQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDescendantBankQuery()} is {@code true} .

    • matchAnyDescendantBank

      void matchAnyDescendantBank(boolean match)
      Matches a bank that has any descendant.
      Parameters:
      match - true to match banks with any descendant banks, false to match leaf banks
      Compliance:
      mandatory - This method must be implemented.

    • clearDescendantBankTerms

      void clearDescendantBankTerms()
      Clears all descendant bank terms.
      Compliance:
      mandatory - This method must be implemented.

    • getBankQueryRecord

      BankQueryRecord getBankQueryRecord(Type bankRecordType) throws OperationFailedException
      Gets the bank query record corresponding to the given Bank record Type .Multiple record retrievals produce a nested OR term.
      Parameters:
      bankRecordType - a bank record type
      Returns:
      the bank query record
      Throws:
      NullArgumentException - bankRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(bankRecordType) is false
      Compliance:
      mandatory - This method must be implemented.