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.templates;
22  
23  import java.util.List;
24  
25  /***
26   * Represents the provider of parameters to an object which has the facility for its 
27   * contents to be template-formatted based on a set of passed-in objects and generate 
28   * a series of resultant objects, typically through a factory-like facility. Generally,
29   * this will be achieved by using a MessageFormat to introduce the passed-in objects 
30   * into fields of copies of the templatizable host that are known to be templatizable. 
31   * For instance, a class may choose to take only the first passed-in
32   * parameter and use it only to format its title field.
33   * 
34   * @author Jeremy Kraybill
35   * @version $Id$
36   */
37  public interface IMultiTemplatizableProvider {
38  
39  	/***
40  	 * Provides a list of lists. Each sub-list represents one set
41  	 * of parameter data. Each sub-list must be the same length.
42  	 * 
43  	 * @return a list of lists of Objects
44  	 */
45  	public List getParameterList();
46  
47  }