Package com.mks.tm.api

Interface ITestCaseIterator

public interface ITestCaseIterator
An iterator over the test cases in the test session. Test case data is paged and therefore requesting the next value from the iterator may result in an error.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getSize()
    Return the total number of test cases.
    boolean
    hasNext()
    Returns true if the iterator has more test cases.
    ITestCase
    next()
    Returns the next test case in the iteration.

  • Method Details

    • hasNext

      boolean hasNext()
      Returns true if the iterator has more test cases.
      Returns:
      true if the iterator has more test cases.

    • next

      ITestCase next() throws TMAPIException
      Returns the next test case in the iteration.

      This method invokes the 'im issues' command via the underlying API session back into the server as needed. The API session user must have ACL permission to Login as well as sufficient workflow and project visibility to view the test case items.

      Returns:
      The next test case in the iteration.
      Throws:
      NoSuchElementException - Iteration has no more test cases.
      TMAPIException - On failure to fetch the test case.

    • getSize

      int getSize() throws TMAPIException
      Return the total number of test cases.
      Returns:
      The total number of test cases.
      Throws:
      TMAPIException - Reserved exception.