01: //$Header$
02: /*
03: * Licensed to the Apache Software Foundation (ASF) under one or more
04: * contributor license agreements. See the NOTICE file distributed with
05: * this work for additional information regarding copyright ownership.
06: * The ASF licenses this file to You under the Apache License, Version 2.0
07: * (the "License"); you may not use this file except in compliance with
08: * the License. You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing, software
13: * distributed under the License is distributed on an "AS IS" BASIS,
14: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15: * See the License for the specific language governing permissions and
16: * limitations under the License.
17: *
18: */
19: package org.apache.jmeter.report.writers;
20:
21: /**
22: * @author Peter Lin
23: *
24: * The purpose of ReportSummary is to provide a detailed description of the
25: * reports generated, how long it took and where the generated files are
26: * located.
27: */
28: public interface ReportSummary extends Cloneable {
29: /**
30: * Add a page summary to the report summary
31: * @param summary
32: */
33: void addPageSummary(PageSummary summary);
34:
35: /**
36: * This should be the elapsed time to run all the reports. Classes
37: * implementing it should simply add up the elapsed time for each
38: * report page.
39: * @return
40: */
41: long getElapsedTime();
42:
43: /**
44: * The method should return a list of the pages generated for the
45: * report and whether it succeeded or not
46: * @return
47: */
48: PageSummary[] getPagesSummaries();
49:
50: /**
51: * Remove a page summary from the report summary.
52: * @param summary
53: */
54: void removePageSummary(PageSummary summary);
55: }
|