1  /*
     2   * Copyright the original author or authors.
     3   * 
     4   * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   * 
     8   *      http://www.mozilla.org/MPL/MPL-1.1.html
     9   * 
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  import org.as2lib.core.BasicInterface;
    18  
    19  /**
    20   * {@code TestResult} holds the result of a test's execution.
    21   * 
    22   * @author Simon Wacker
    23   */
    24  interface org.as2lib.test.speed.TestResult extends BasicInterface {
    25  	
    26  	/**
    27  	 * Returns the name of the test.
    28  	 * 
    29  	 * @return the test's name
    30  	 */
    31  	public function getName(Void):String;
    32  	
    33  	/**
    34  	 * Returns the total invocation time in milliseconds.
    35  	 * 
    36  	 * @return the total invocation time in milliseconds
    37  	 */
    38  	public function getTime(Void):Number;
    39  	
    40  	/**
    41  	 * Returns the invocation time as percentage in relation to the passed-in
    42  	 * {@code totalTime}.
    43  	 * 
    44  	 * @param totalTime the total time to calculate the percentage with
    45  	 * @return the invocation time as percentage
    46  	 */
    47  	public function getTimePercentage(totalTime:Number):Number;
    48  	
    49  }
as2api