org.alfresco.po.share.search.SearchBox.java Source code

Introduction

Here is the source code for org.alfresco.po.share.search.SearchBox.java

Source

/*
 * #%L
 * share-po
 * %%
 * Copyright (C) 2005 - 2016 Alfresco Software Limited
 * %%
 * This file is part of the Alfresco software. 
 * If the software was purchased under a paid Alfresco license, the terms of 
 * the paid license agreement will prevail.  Otherwise, the software is 
 * provided under the following open source license terms:
 * 
 * Alfresco is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * Alfresco is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 * #L%
 */
package org.alfresco.po.share.search;

import org.alfresco.po.HtmlPage;
import org.alfresco.po.exception.PageException;
import org.alfresco.po.share.SharePage;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.openqa.selenium.By;
import org.openqa.selenium.NoSuchElementException;
import org.openqa.selenium.TimeoutException;
import org.openqa.selenium.WebElement;

/**
 * Represent elements found on the html page relating to the search
 * functionality.
 * 
 * @author Michael Suzuki
 * @author Shan Nagarajan
 * @since 1.1
 */
public class SearchBox extends SharePage {
    private final Log logger = LogFactory.getLog(SearchBox.class);
    private final By selector = By.cssSelector("input[id='HEADER_SEARCHBOX_FORM_FIELD']");

    /**
     * Performs the search by entering the term into search field
     * and submitting the search.
     * 
     * @param term String term to search
     * @return true when actioned
     */
    public HtmlPage search(final String term) {
        if (term == null || term.isEmpty()) {
            throw new UnsupportedOperationException("Search term is required to perform a search");
        }
        try {
            WebElement input = driver.findElement(selector);
            input.clear();
            input.sendKeys(term + "\n");
            if (logger.isTraceEnabled()) {
                logger.trace("Apply search on the keyword: " + term);
            }

        } catch (NoSuchElementException nse) {
        }
        return getCurrentPage();
    }

    /**
     * Performs the live search by typing the term into search field
     * 
     * @param term String term to search
     * @return true when actioned
     */
    public HtmlPage liveSearch(final String term) {
        if (term == null || term.isEmpty()) {
            throw new UnsupportedOperationException("Search term is required to perform a search");
        }
        try {

            WebElement input = findAndWait(selector);
            input.clear();
            input.sendKeys(term);
            input.click();
            if (logger.isTraceEnabled()) {
                logger.trace("Apply live search on the keyword: " + term);
            }
            return factoryPage.instantiatePage(driver, LiveSearchDropdown.class);
        } catch (TimeoutException nse) {
            throw new PageException("Live search not displayed.");
        }
    }
}