com.github.jsdevel.testng.selenium.Page Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of testng-selenium Show documentation

A library for easy TestNG Selenium testing.

There is a newer version: 0.11.2

package com.github.jsdevel.testng.selenium;

import java.net.URL;
import org.openqa.selenium.WebDriver;

/**
 * Represents a page that has been configured.
 * 
 * @param  The configured Page.
 * @param  The PageFactory that build this page.
 * @see AbstractPage
 * @author Joe Spencer
 */
public interface Page {
  /**
   * Returns the context of the Method annotated with
   * {@link org.testng.annotations.Test}.
   * 
   * @return The method context.
   */
  MethodContext getContext();

  /**
   * Returns the endpoint that was configured for the current test run.
   * 
   * @return The endpoint.
   */
  String getEndpoint();

  /**
   * Returns the URL that was used during page initialization.
   * 
   * @return The initial URL.
   */
  URL getInitialUrl();

  /**
   * Returns this Page.
   * 
   * @return This Page.
   */
  Page getPage();

  /**
   * The PageFactory instance that built this Page.
   * 
   * @return  The PageFactory that built this Page.
   */
  PF getPageFactory();

  /**
   * Returns the {@link org.openqa.selenium.WebDriver} that has been configured
   * for this test run.
   * 
   * @return The {@link org.openqa.selenium.WebDriver}.
   */
  WebDriver getWebDriver(); 

  /**
   * Allows the page to signal whether or not it can be viewed from the provided
   * URL.
   * 
   * @param proposedUrl The proposed URL.
   * @return this Page.
   */
  boolean isPageViewableFrom(URL proposedUrl);
}