org.jbehaviour.xref.IBehaviourXRef Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jbehaviour-engine Show documentation
The newest version!
/**
 *  Copyright 2012 Yannick Roffin
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *   limitations under the License.
 */

package org.jbehaviour.xref;

import java.io.File;
import java.util.List;
import java.util.Map;

import org.jbehaviour.report.IBehaviourReportRun;

public interface IBehaviourXRef {
	/**
	 * start counter
	 * @return
	 */
	public Long start();
	/**
	 * retrieve run sort by scenario
	 * @return
	 */
	public Map getRunsByScenario();
	/**
	 * stop counter for this run, and store in session
	 * @param begin
	 * @param pck
	 * @param klass
	 * @param name
	 * @param object
	 * @param args
	 * @param text
	 * @param excp 
	 * @param result 
	 * @param stderr 
	 * @param stdout 
	 * @return
	 */
	public Long stop(String pck, Long begin, String klass, String name, Object object, Object[] args, String text, File stdout, File stderr, Object result, Exception excp);
	
	/**
	 * release all ressources taken during step
	 * invocation
	 */
	public void release();

	/**
	 * get all step disabled
	 * @return
	 */
	public int getDisabled();
	/**
	 * get all step in error
	 * @return
	 */
	public int getErrors();
	/**
	 * get all step in failure
	 * @return
	 */
	public int getFailures();
	/**
	 * get name
	 * @return
	 */
	public String getName();
	/**
	 * setName
	 * @param name
	 */
	void setName(String name);
	/**
	 * get all step (counter)
	 * @return
	 */
	public int getTests();
	/**
	 * get all global time
	 * @return
	 */
	public long getTime();
	/**
	 * retrieve the list of run
	 * @return
	 */
	List getRuns();
}