View Javadoc

1   /*
2    * The contents of this file are subject to the terms 
3    * of the Common Development and Distribution License 
4    * (the "License").  You may not use this file except 
5    * in compliance with the License.
6    * 
7    * You can obtain a copy of the license at 
8    * http://www.sun.com/cddl/cddl.html. 
9    * See the License for the specific language governing 
10   * permissions and limitations under the License.
11   * 
12   * When distributing Covered Code, include this CDDL 
13   * HEADER in each file and include the License file at 
14   * license.txt.  If applicable, add the following below 
15   * this CDDL HEADER, with the fields enclosed by brackets 
16   * "[]" replaced with your own identifying information: 
17   * Portions Copyright [yyyy] [name of copyright owner]
18   * 
19   * Portions Copyright 2004 eBay, Inc.
20   */
21  package com.ebay.carad.os.vitalsigns;
22  
23  import java.util.List;
24  
25  /***
26   * Represents a contained list of zero or more <code>IDashboardReport</code> configurations. This
27   * is used to facilitate meta-reports, which can be containers that auto-generate their
28   * contents based on templated reports. 
29   * 
30   * @author Jeremy Kraybill
31   * @author Jeremy Thomerson
32   * @version $Id$
33   */
34  public interface IDashboardReportContainer {
35  
36  	/***
37  	 * Returns an iterator over zero or more <code>IDashboardReport</code> objects.
38  	 * 
39  	 * @return a list of <code>IDashboardReport</code> objects.
40  	 */
41  	public List getReports();
42  	
43  	/***
44  	 * Defines the sort order of this container's report(s).
45  	 * 
46  	 * @return a sort order for ordering reports
47  	 */
48  	public int getSortOrder();
49  
50      /***
51       * @return the name of the group that these reports should appear in, 
52       * or null if they should appear individually
53       */
54      public String getGroupName();
55  
56  }