com.nordstrom.automation.selenium.model.ReferenceFetcher Maven / Gradle / Ivy

Go to download

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

Selenium Foundation is an automation framework designed to extend and enhance the capabilities provided by Selenium (WebDriver).

There is a newer version: 28.3.1-s4

Show newest version

package com.nordstrom.automation.selenium.model;

import org.openqa.selenium.By;
import org.openqa.selenium.SearchContext;
import org.openqa.selenium.StaleElementReferenceException;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.WrapsElement;

import com.nordstrom.automation.selenium.interfaces.WrapsContext;

/**
 * This interface defines the methods that are added to {@link WebElement} to create {@link RobustElementWrapper}.
 */
public interface ReferenceFetcher extends SearchContext, WrapsElement, WrapsContext, Enhanced {
    
    /**
     * Get a wrapped reference to the first element matching the specified locator.
     * 
     * NOTE: Use {@link ReferenceFetcher#hasReference()} to determine if a valid reference was acquired.
     * 
     * @param by the locating mechanism
     * @return robust web element
     */
    WebElement findOptional(By by);

    /**
     * Determine if this robust element wraps a valid reference.
     * 
     * @return 'true' if reference was acquired; otherwise 'false'
     */
    boolean hasReference();

    /**
     * Get the search context for this element.
     * 
     * @return element search context
     */
    WrapsContext getContext();
    
    /**
     * Get the locator for this element.
     * 
     * @return element locator
     */
    By getLocator();
    
    /**
     * Get the element index.
     * 
     * NOTE: {@link RobustElementWrapper#CARDINAL CARDINAL} = 1st matched reference;
     *              {@link RobustElementWrapper#OPTIONAL OPTIONAL} = an optional reference
     * 
     * @return element index (see NOTE)
     */
    int getIndex();
    
    /**
     * Refresh the wrapped element reference.
     * 
     * @param refreshTrigger {@link StaleElementReferenceException} that necessitates reference refresh
     * @return this robust element wrapper with refreshed reference
     */
    RobustElementWrapper refreshReference(StaleElementReferenceException refreshTrigger);
}