net.sourceforge.jbizmo.commons.selenium.data.ITestDataProvider Maven / Gradle / Ivy

Go to download

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

There is a newer version: 10.0.0

Show newest version

/*
 * This file is part of JBizMo, a set of tools, libraries and plug-ins
 * for modeling and creating Java-based enterprise applications.
 * For more information visit:
 *
 * http://sourceforge.net/projects/jbizmo/
 *
 * This software is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This software 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this software; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */
package net.sourceforge.jbizmo.commons.selenium.data;

import net.sourceforge.jbizmo.commons.selenium.util.SeleniumTestProperties;

/**
 * 
 * Common interface that must be implemented by all test data providers
 * 
 * 
 * Copyright 2017 (C) by Martin Ganserer
 * 
 * @author Martin Ganserer
 * @version 1.0.0
 */
public interface ITestDataProvider
{
	/**
	 * Provide basic properties for provider initialization
	 * @param properties
	 */
	void setProperties(SeleniumTestProperties properties);

	/**
	 * Initialize test data provider for a given test case
	 * @param testCaseClass
	 * @throws RuntimeException if the initialization has failed due to an internal error
	 */
	void init(Class testCaseClass);

	/**
	 * Provides the next page action test data object for a given page object
	 * @param pageClass
	 * @return the page action test data for the given page object or null if no respective object is (no longer) available
	 * @throws RuntimeException if the provider doesn't contain page action test data for the given page object
	 */
	PageActionTestData getNextTestDataForPage(Class pageClass);
}