View Javadoc

1   /*
2    *  soapUI, copyright (C) 2006 eviware.com 
3    *
4    *  soapUI is free software; you can redistribute it and/or modify it under the 
5    *  terms of the GNU Lesser General Public License as published by the Free Software Foundation; 
6    *  either version 2.1 of the License, or (at your option) any later version.
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.ActionList;
18  
19  /***
20   * A TestStep result
21   * 
22   * @author Ole.Matzura
23   */
24  
25  public interface TestStepResult 
26  {
27     public enum TestStepStatus { UNKNOWN, OK, FAILED, CANCELED }
28  
29  	public TestStepStatus getStatus();
30  
31  	public TestStep getTestStep();
32  	
33  	/***
34  	 * Returns a list of actions that can be applied to this result
35  	 */
36  	
37  	public ActionList getActions();
38  	
39  	public String [] getMessages();
40  	
41  	public long getTimeTaken();
42  	
43  	public long getTimeStamp();
44  	
45  	/***
46  	 * Used for calculating throughput
47  	 * 
48  	 * @return the number of bytes in this result
49  	 */
50  	
51  	public long getSize();
52  	
53  	/***
54  	 * Writes this result to the specified writer, used for logging.
55  	 */
56  
57  	public void writeTo(PrintWriter writer);
58  	
59  	/***
60  	 * Can discard any result data that may be taking up memory. Timing-values 
61  	 * must not be discarded.
62  	 */
63  	
64  	public void discard();
65  	
66  	public boolean isDiscarded();
67  }