View Javadoc

1   /*
2    *  soapUI, copyright (C) 2004-2009 eviware.com 
3    *
4    *  soapUI is free software; you can redistribute it and/or modify it under the 
5    *  terms of version 2.1 of the GNU Lesser General Public License as published by 
6    *  the Free Software Foundation.
7    *
8    *  soapUI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without 
9    *  even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
10   *  See the GNU Lesser General Public License for more details at gnu.org.
11   */
12  
13  package com.eviware.soapui.model.testsuite;
14  
15  import java.io.PrintWriter;
16  
17  import com.eviware.soapui.support.action.swing.ActionList;
18  
19  /***
20   * A TestStep result
21   * 
22   * @author Ole.Matzura
23   */
24  
25  public interface TestStepResult
26  {
27  	public enum TestStepStatus
28  	{
29  		UNKNOWN, OK, FAILED, CANCELED
30  	}
31  
32  	public TestStepStatus getStatus();
33  
34  	public TestStep getTestStep();
35  
36  	/***
37  	 * Returns a list of actions that can be applied to this result
38  	 */
39  
40  	public ActionList getActions();
41  
42  	public String[] getMessages();
43  
44  	public Throwable getError();
45  
46  	public long getTimeTaken();
47  
48  	public long getTimeStamp();
49  
50  	/***
51  	 * Used for calculating throughput
52  	 * 
53  	 * @return the number of bytes in this result
54  	 */
55  
56  	public long getSize();
57  
58  	/***
59  	 * Writes this result to the specified writer, used for logging.
60  	 */
61  
62  	public void writeTo( PrintWriter writer );
63  
64  	/***
65  	 * Can discard any result data that may be taking up memory. Timing-values
66  	 * must not be discarded.
67  	 */
68  
69  	public void discard();
70  
71  	public boolean isDiscarded();
72  }