Conductor (conductor 2.2.4 API)

All Known Implementing Classes:

Locomotive
```
public interface Conductor<Test>
```
Since:

v2, Apr 03, 2015

Author:

ddavison

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`Test`	`check(org.openqa.selenium.By by)`
`Test`	`check(String css)` Check a checkbox, or radio button
`Test`	`click(org.openqa.selenium.By by)`
`Test`	`click(String css)` Click an element.
`Test`	`closeWindow()` Closes the current active window.
`Test`	`closeWindow(String regex)` Close an open window.
`String`	`get(String key)` Get a variable from the data warehouse. If the key is not set, then use `get(String, String)`
`String`	`get(String key, String defaultValue)` Get a variable from the data warehouse.
`String`	`getAttribute(org.openqa.selenium.By by, String attribute)`
`String`	`getAttribute(String css, String attribute)` Get an attribute of an element
`String`	`getText(org.openqa.selenium.By by)`
`String`	`getText(String css)` Get the text of an element.
`Test`	`goBack()` Navigates the browser back one page.
`Test`	`hoverOver(org.openqa.selenium.By by)`
`Test`	`hoverOver(String css)` Hover over an element.
`boolean`	`isChecked(org.openqa.selenium.By by)`
`boolean`	`isChecked(String css)` Checks if the element is checked or not.
`boolean`	`isPresent(org.openqa.selenium.By by)`
`boolean`	`isPresent(String css)` Checks if the element is present or not.
`Test`	`log(Object object)` Log something as information
`Test`	`logDebug(Object object)` Log something as debug
`Test`	`logError(Object object)` Log something as an error
`Test`	`logFatal(Object object)` Log something as fatal
`Test`	`logInfo(Object object)` Log something as information
`Test`	`logWarn(Object object)` Log something as a warning
`Test`	`navigateTo(String url)` Navigates to an absolute or relative Url.
`Test`	`refresh()` Refresh the page
`Test`	`selectOptionByText(org.openqa.selenium.By by, String text)`
`Test`	`selectOptionByText(String css, String text)` Selects an option from a dropdown (<select> tag) based on the text displayed.
`Test`	`selectOptionByValue(org.openqa.selenium.By by, String value)`
`Test`	`selectOptionByValue(String css, String value)` Selects an option from a dropdown (<select> tag) based on the value.
`Test`	`setAndValidateText(org.openqa.selenium.By by, String text)` Deprecated. use `setText("selector", "text") .validateText("selector", "text")` instead
`Test`	`setAndValidateText(String css, String text)` Deprecated. use `setText("selector", "text") .validateText("selector", "text")` instead
`Test`	`setText(org.openqa.selenium.By by, String text)`
`Test`	`setText(String css, String text)` Clears the text from a text field, and sets it.
`Test`	`store(String key, String value)` Put a variable in the data warehouse.
`Test`	`switchToDefaultContent()` Switch back to the default content (the first window / frame that you were on before switching)
`Test`	`switchToFrame(int index)` Switches to a frame based on the index it comes.
`Test`	`switchToFrame(String idOrName)` Switches to a frame or iframe.
`Test`	`switchToFrame(org.openqa.selenium.WebElement webElement)` Switches to a frame based on a found WebElement
`Test`	`switchToWindow(String regex)` Switch's to a window that is already in existance.
`Test`	`uncheck(org.openqa.selenium.By by)`
`Test`	`uncheck(String css)` Uncheck a checkbox, or radio button
`Test`	`validateAttribute(org.openqa.selenium.By by, String attr, String regex)`
`Test`	`validateAttribute(String css, String attr, String regex)` Validates an attribute of an element. Example: <input type="text" id="test" /> `.validateAttribute("input#test", "type", "text") // validates that the "type" attribute equals "test"`
`Test`	`validateChecked(org.openqa.selenium.By by)`
`Test`	`validateChecked(String css)` Validate that a checkbox or a radio button is checked.
`Test`	`validateFalse(boolean condition)` Validates that a specific condition is false
`Test`	`validateNotPresent(org.openqa.selenium.By by)`
`Test`	`validateNotPresent(String css)` Validates that an element is not present.
`Test`	`validatePresent(org.openqa.selenium.By by)`
`Test`	`validatePresent(String css)` Validates that an element is present.
`Test`	`validateText(org.openqa.selenium.By by, String text)`
`Test`	`validateText(String css, String text)` Validate that the text of an element is correct.
`Test`	`validateTextNot(org.openqa.selenium.By by, String text)`
`Test`	`validateTextNot(String css, String text)` Validate that the text of an element is not matching text.
`Test`	`validateTextNotPresent(String text)` Validate that some text is nowhere on the page.
`Test`	`validateTextPresent(String text)` Validate that text is present somewhere on the page.
`Test`	`validateTrue(boolean condition)` Validates that a specific condition is true
`Test`	`validateUnchecked(org.openqa.selenium.By by)`
`Test`	`validateUnchecked(String css)` Validate that a checkbox or a radio button is unchecked.
`Test`	`validateUrl(String regex)` Validate the Url
`Test`	`waitForCondition(org.openqa.selenium.support.ui.ExpectedCondition<?> condition, long timeOutInSeconds, long sleepInMillis)` Wait for a specific condition before continuing
`org.openqa.selenium.WebElement`	`waitForElement(org.openqa.selenium.By by)`
`Test`	`waitForWindow(String regex)` Waits for a window to appear, then switches to it.

- Method Detail
  - waitForElement
```
org.openqa.selenium.WebElement waitForElement(org.openqa.selenium.By by)
```
  - click
```
Test click(String css)
```
    Click an element.
    
    Parameters:
    
    css/by - The element to click.
    
    Returns:
    
    The implementing class for fluency
  - click
```
Test click(org.openqa.selenium.By by)
```
  - setText
```
Test setText(String css,
             String text)
```
    Clears the text from a text field, and sets it.
    
    Parameters:
    
    css/by - The element to set the text of.
    
    text - The text that the element will have.
    
    Returns:
    
    The implementing class for fluency
  - setText
```
Test setText(org.openqa.selenium.By by,
             String text)
```
  - hoverOver
```
Test hoverOver(String css)
```
    Hover over an element.
    
    Parameters:
    
    css/by - The element to hover over.
    
    Returns:
    
    The implementing class for fluency
  - hoverOver
```
Test hoverOver(org.openqa.selenium.By by)
```
  - isChecked
```
boolean isChecked(String css)
```
    Checks if the element is checked or not.
    
    Parameters:
    
    css/by - The checkbox
    
    Returns:
    
    this method is not meant to be used fluently.
    
    Returns true if the element is checked. and false if it's not.
  - isChecked
```
boolean isChecked(org.openqa.selenium.By by)
```
  - isPresent
```
boolean isPresent(String css)
```
    Checks if the element is present or not.
    
    Parameters:
    
    css/by - The element
    
    Returns:
    
    this method is not meant to be used fluently.
    
    . Returns true if the element is present. and false if it's not.
  - isPresent
```
boolean isPresent(org.openqa.selenium.By by)
```
  - getText
```
String getText(String css)
```
    Get the text of an element.
    This is a consolidated method that works on input's, as select boxes, and fetches the value rather than the innerHTMl.
    
    Parameters:
    
    css/by - The element
    
    Returns:
    
    The implementing class for fluency
  - getText
```
String getText(org.openqa.selenium.By by)
```
  - getAttribute
```
String getAttribute(String css,
                    String attribute)
```
    Get an attribute of an element
    
    Parameters:
    
    css/by - The element to get the attribute from
    
    attribute - The attribute to get
    
    Returns:
    
    The implementing class for fluency
  - getAttribute
```
String getAttribute(org.openqa.selenium.By by,
                    String attribute)
```
  - check
```
Test check(String css)
```
    Check a checkbox, or radio button
    
    Parameters:
    
    css/by - The element to check
    
    Returns:
    
    The implementing class for fluency
  - check
```
Test check(org.openqa.selenium.By by)
```
  - uncheck
```
Test uncheck(String css)
```
    Uncheck a checkbox, or radio button
    
    Parameters:
    
    css/by - The element to uncheck
    
    Returns:
    
    The implementing class for fluency
  - uncheck
```
Test uncheck(org.openqa.selenium.By by)
```
  - selectOptionByText
```
Test selectOptionByText(String css,
                        String text)
```
    Selects an option from a dropdown (<select> tag) based on the text displayed.
    
    Parameters:
    
    css/by - The element
    
    text - The text that is displaying.
    
    Returns:
    
    The implementing class for fluency
    
    See Also:
    
    selectOptionByValue(By, String)
  - selectOptionByText
```
Test selectOptionByText(org.openqa.selenium.By by,
                        String text)
```
  - selectOptionByValue
```
Test selectOptionByValue(String css,
                         String value)
```
    Selects an option from a dropdown (<select> tag) based on the value.
    
    Parameters:
    
    css/by - The element
    
    value - The value attribute of the option.
    
    Returns:
    
    The implementing class for fluency
    
    See Also:
    
    selectOptionByText(By, String)
  - selectOptionByValue
```
Test selectOptionByValue(org.openqa.selenium.By by,
                         String value)
```
  - waitForWindow
```
Test waitForWindow(String regex)
```
    Waits for a window to appear, then switches to it.
    
    Parameters:
    
    regex - Regex enabled. Url of the window, or title.
    
    Returns:
    
    The implementing class for fluency
  - switchToWindow
```
Test switchToWindow(String regex)
```
    Switch's to a window that is already in existance.
    
    Parameters:
    
    regex - Regex enabled. Url of the window, or title.
    
    Returns:
    
    The implementing class for fluency
  - closeWindow
```
Test closeWindow(String regex)
```
    Close an open window.
    If you have opened only 1 external window, then when you call this method, the context will switch back to the window you were using before.
    
    If you had more than 2 windows displaying, then you will need to call switchToWindow(String) to switch back context.
    
    Parameters:
    
    regex - The title of the window to close (regex enabled). You may specify null to close the active window. If you specify null then the context will switch back to the initial window.
    
    Returns:
    
    The implementing class for fluency
  - closeWindow
```
Test closeWindow()
```
    Closes the current active window. Calling this method will return the context back to the initial window.
    
    Returns:
    
    The implementing class for fluency
  - switchToFrame
```
Test switchToFrame(String idOrName)
```
    Switches to a frame or iframe.
    
    Parameters:
    
    idOrName - The id or name of the frame.
    
    Returns:
    
    The implementing class for fluency
  - switchToFrame
```
Test switchToFrame(int index)
```
    Switches to a frame based on the index it comes. (starting at 0)
    
    Parameters:
    
    index - The index of the frame in which it appears
    
    Returns:
    
    The implementing class for fluency
  - switchToFrame
```
Test switchToFrame(org.openqa.selenium.WebElement webElement)
```
    Switches to a frame based on a found WebElement
    
    Parameters:
    
    webElement - The WebElement object that was found.
    
    Returns:
    
    The implementing class for fluency
  - switchToDefaultContent
```
Test switchToDefaultContent()
```
    Switch back to the default content (the first window / frame that you were on before switching)
    
    Returns:
    
    The implementing class for fluency
  - validatePresent
```
Test validatePresent(String css)
```
    Validates that an element is present.
    
    Parameters:
    
    css/by - The element
    
    Returns:
    
    The implementing class for fluency
  - validatePresent
```
Test validatePresent(org.openqa.selenium.By by)
```
  - validateNotPresent
```
Test validateNotPresent(String css)
```
    Validates that an element is not present.
    
    Parameters:
    
    css/by - The element
    
    Returns:
    
    The implementing class for fluency
  - validateNotPresent
```
Test validateNotPresent(org.openqa.selenium.By by)
```
  - validateText
```
Test validateText(String css,
                  String text)
```
    Validate that the text of an element is correct.
    
    Parameters:
    
    css/by - The element to validate the text of.
    
    text - The text the element should have.
    
    Returns:
    
    The implementing class for fluency
  - validateText
```
Test validateText(org.openqa.selenium.By by,
                  String text)
```
  - validateTextNot
```
Test validateTextNot(String css,
                     String text)
```
    Validate that the text of an element is not matching text.
    
    Parameters:
    
    css/by - The element to validate the text of.
    
    text - The text the element should not have.
    
    Returns:
    
    The implementing class for fluency
  - validateTextNot
```
Test validateTextNot(org.openqa.selenium.By by,
                     String text)
```
  - validateTextPresent
```
Test validateTextPresent(String text)
```
    Validate that text is present somewhere on the page.
    
    Parameters:
    
    text - The text to ensure is on the page.
    
    Returns:
    
    The implementing class for fluency
  - validateTextNotPresent
```
Test validateTextNotPresent(String text)
```
    Validate that some text is nowhere on the page.
    
    Parameters:
    
    text - The text to ensure is not on the page.
    
    Returns:
    
    The implementing class for fluency
  - validateChecked
```
Test validateChecked(String css)
```
    Validate that a checkbox or a radio button is checked.
    
    Parameters:
    
    css/by - The element
    
    Returns:
    
    The implementing class for fluency
  - validateChecked
```
Test validateChecked(org.openqa.selenium.By by)
```
  - validateUnchecked
```
Test validateUnchecked(String css)
```
    Validate that a checkbox or a radio button is unchecked.
    
    Parameters:
    
    css/by - The element
    
    Returns:
    
    The implementing class for fluency
  - validateUnchecked
```
Test validateUnchecked(org.openqa.selenium.By by)
```
  - validateAttribute
```
Test validateAttribute(String css,
                       String attr,
                       String regex)
```
    Validates an attribute of an element.
    
    Example:
    
    <input type="text" id="test" />
    
    .validateAttribute("input#test", "type", "text") // validates that the "type" attribute equals "test"
    
    Parameters:
    
    css/by - The element
    
    attr - The attribute you'd like to validate
    
    regex - What the attribute should be. (this method supports regex)
    
    Returns:
    
    The implementing class for fluency
  - validateAttribute
```
Test validateAttribute(org.openqa.selenium.By by,
                       String attr,
                       String regex)
```
  - validateUrl
```
Test validateUrl(String regex)
```
    Validate the Url
    
    Parameters:
    
    regex - Regular expression to match
    
    Returns:
    
    The implementing class for fluency
  - validateTrue
```
Test validateTrue(boolean condition)
```
    Validates that a specific condition is true
    
    Parameters:
    
    condition - The condition that is expected to be true
    
    Returns:
    
    The implementing class for fluency
  - validateFalse
```
Test validateFalse(boolean condition)
```
    Validates that a specific condition is false
    
    Parameters:
    
    condition - The condition that is expected to be false
    
    Returns:
    
    The implementing class for fluency
  - setAndValidateText
```
@Deprecated
Test setAndValidateText(String css,
                                    String text)
```
    Deprecated. use
    setText("selector", "text") .validateText("selector", "text") instead
    
    Set and validate the text in a single step
    
    Parameters:
    
    css/by - The element to set and validate the text of.
    
    text - The text to set and validate
    
    Returns:
    
    The implementing class for fluency
  - setAndValidateText
```
@Deprecated
Test setAndValidateText(org.openqa.selenium.By by,
                                    String text)
```
    Deprecated. use
    setText("selector", "text") .validateText("selector", "text") instead
  - navigateTo
```
Test navigateTo(String url)
```
    Navigates to an absolute or relative Url.
    
    Parameters:
    
    url - Use cases are:
    
    navigateTo("/login") // navigate to a relative url. slash meaning start fresh from the base url.
    
    navigateTo("path") // navigate to a relative url. will simply append "path" to the current url.
    
    navigateTo("http://google.com") // navigates to an absolute url.
    
    Returns:
    
    The implementing class for fluency
  - goBack
```
Test goBack()
```
    Navigates the browser back one page. Same as driver.navigate().back()
    
    Returns:
    
    The implementing class for fluency
  - refresh
```
Test refresh()
```
    Refresh the page
    
    Returns:
    
    The implementing class for fluency
  - store
```
Test store(String key,
           String value)
```
    Put a variable in the data warehouse.
    
    Parameters:
    
    key - The key to put.
    
    value - The value to put.
    
    Returns:
    
    The implementing class for fluency
  - get
```
String get(String key)
```
    Get a variable from the data warehouse.
    
    If the key is not set, then use get(String, String)
    
    Parameters:
    
    key - The key to fetch.
    
    Returns:
    
    The implementing class for fluency
  - get
```
String get(String key,
           String defaultValue)
```
    Get a variable from the data warehouse.
    
    Parameters:
    
    key - The key to fetch.
    
    defaultValue - The value to return if the variable is not set.
    
    Returns:
    
    The implementing class for fluency
  - log
```
Test log(Object object)
```
    Log something as information
    
    Parameters:
    
    object - What to log.
    
    Returns:
    
    The implementing class for fluency
  - logInfo
```
Test logInfo(Object object)
```
    Log something as information
    
    Parameters:
    
    object - What to log
    
    Returns:
    
    The implementing class for fluency
  - logWarn
```
Test logWarn(Object object)
```
    Log something as a warning
    
    Parameters:
    
    object - What to log
    
    Returns:
    
    The implementing class for fluency
  - logError
```
Test logError(Object object)
```
    Log something as an error
    
    Parameters:
    
    object - What to log
    
    Returns:
    
    AutomationTest (for fluency)
  - logDebug
```
Test logDebug(Object object)
```
    Log something as debug
    
    Parameters:
    
    object - What to log
    
    Returns:
    
    The implementing class for fluency
  - logFatal
```
Test logFatal(Object object)
```
    Log something as fatal
    
    Parameters:
    
    object - What to log
    
    Returns:
    
    The implementing class for fluency
  - waitForCondition
```
Test waitForCondition(org.openqa.selenium.support.ui.ExpectedCondition<?> condition,
                      long timeOutInSeconds,
                      long sleepInMillis)
```
    Wait for a specific condition before continuing
    
    Parameters:
    
    condition - the condition to wait for
    
    timeOutInSeconds - how long to wait
    
    sleepInMillis - the delay between waits
    
    Returns:
    
    The implementing class for fluency

Interface Conductor<Test>

Method Summary

Method Detail

waitForElement

click

click

setText

setText

hoverOver

hoverOver

isChecked

isChecked

isPresent

isPresent

getText

getText

getAttribute

getAttribute

check

check

uncheck

uncheck

selectOptionByText

selectOptionByText

selectOptionByValue

selectOptionByValue

waitForWindow

switchToWindow

closeWindow

closeWindow

switchToFrame

switchToFrame

switchToFrame

switchToDefaultContent

validatePresent

validatePresent

validateNotPresent

validateNotPresent

validateText

validateText

validateTextNot

validateTextNot

validateTextPresent

validateTextNotPresent

validateChecked

validateChecked

validateUnchecked

validateUnchecked

validateAttribute

validateAttribute

validateUrl

validateTrue

validateFalse

setAndValidateText

setAndValidateText

navigateTo

goBack

refresh

store

get

get

log

logInfo

logWarn

logError

logDebug

logFatal

waitForCondition