View Javadoc

1   package com.atlassian.pageobjects.elements.query;
2   
3   import com.atlassian.pageobjects.elements.timeout.Timeouts;
4   
5   /**
6    * A query over the state of the current test that is capable of being repeated at given intervals in an attempt to
7    * wait for a desired result.
8    *
9    */
10  public interface PollingQuery
11  {
12      public static final long DEFAULT_INTERVAL = Timeouts.DEFAULT_INTERVAL;
13  
14      /**
15       * An interval (in milliseconds) that will be used to periodically evaluate the query.
16       *
17       * @return evaluation interval of this query.
18       */
19      long interval();
20  
21      /**
22       * Default timeout (in milliseconds) of this query in the current test context.
23       *
24       * @return default timeout of this query
25       */
26      long defaultTimeout();
27  }