Package allurium.interfaces

Interface Selectable

All Superinterfaces:
AlluriumElement, WebElementMeta
All Known Implementing Classes:
DropdownSelect, Select
public interface Selectable extends AlluriumElement
Interface for components that support selection actions, such as dropdown lists or other selectable elements.

This interface standardizes the methods used for selecting options or elements, providing consistency in how selections are handled across different components.

Features:

  • Methods for selecting elements by value, index, or criteria.
  • Support for generic selection logic, including first, last, or random selections.
  • Option to exclude specific values during selection.

Purpose:

  • Encapsulates selection behavior for various UI elements.
  • Provides a standardized interface for implementing selectable components.

Common Implementations:

  • Select option lists
  • Dropdown menus
  • Custom list components

Example Usage:


 public class DropdownSelect implements Selectable {
     public void select(String value) { ... }
     public void selectFirst() { ... }
     public void selectLast() { ... }
     public void selectAny() { ... }
     public void selectAnyBesides(String value) { ... }
 }

 // In a test case:
 DropdownSelect dropdown = new DropdownSelect();
 dropdown.select("Option 1");
 dropdown.selectAnyBesides("Excluded Option");

  • Method Details

    • select

      void select(String value) throws org.openqa.selenium.InvalidArgumentException
      Selects an element based on its value.

      This method allows selecting an element by matching its value. If the value does not exist, an InvalidArgumentException is thrown.

      Example:

      
 Selectable selectable = new DropdownSelect();
 selectable.select("Option 1");
      Parameters:
      value - the value of the element to select
      Throws:
      org.openqa.selenium.InvalidArgumentException - if the value does not exist

    • selectFirst

      void selectFirst()
      Selects the first available element in the component.

      Useful for components where selecting the first element is a valid test scenario.

      Example:

      
 Selectable selectable = new DropdownSelect();
 selectable.selectFirst();

    • selectLast

      void selectLast()
      Selects the last available element in the component.

      Useful for components where selecting the last element is relevant for the test scenario.

      Example:

      
 Selectable selectable = new DropdownSelect();
 selectable.selectLast();

    • selectAny

      void selectAny()
      Selects any available element in the component.

      A random selection from the available options. This can be useful for tests where the specific selected value is not important.

      Example:

      
 Selectable selectable = new DropdownSelect();
 selectable.selectAny();

    • selectAnyBesides

      void selectAnyBesides(String value)
      Selects any available element except the one specified by its value.

      Filters the options to exclude the specified value and then selects one of the remaining options. Throws an exception if there are no available options except the excluded value.

      Example:

      
 Selectable selectable = new DropdownSelect();
 selectable.selectAnyBesides("Excluded Option");
      Parameters:
      value - the value to exclude from the selection
      Throws:
      org.openqa.selenium.InvalidArgumentException - if there are no options available except the excluded value