View Javadoc

1   package mx.com.brained.model;
2   
3   import org.apache.commons.beanutils.*;
4   import java.util.*;
5   /***
6    *
7    * <p>Title: AwTaglib</p>
8    *
9    * <p>Description: Interface that defines the basic methods that an object must implement to handle the data sent by
10   * the grid to easy process it in a java application</p>
11   *
12   * <p>Copyright: Copyright (c) 2005</p>
13   *
14   * <p>Company: Brain-ED</p>
15   *
16   * @author Isidoro Treviņo
17   * @version 1.0
18   */
19  public interface AwGrid extends DynaBean{
20      /***
21       * Returns a collection containing the data with the specified state
22       * @param state String
23       * @return Collection
24       */
25      public Collection getData(String state);
26      /***
27       * Set the type of class that will be populated with the grid's sent data
28       * @param klass Class
29       */
30      public void setDataClass(Class klass);
31      /***
32       * Get the name of the properties that the data class contains
33       * @return List
34       */
35      public List getPropertyNames();
36      /***
37       * Initialize the grid with some data
38       * @param data List
39       */
40      public void setDataList(List data);
41      /***
42       * Returns the full collection containing the data, regardless of its state
43       * @return Collection
44       */
45      public Collection getDataList();
46      /***
47       * Set the identifier that will be used to identify the special data status field. </br> Defaults to "dataStatus"
48       * @param state String
49       */
50      public void setStateString(String state);
51      /***
52       * Set the identifier that will be used to identify the special header field. </br> Defaults to "header"
53       * @param header String
54       */
55      public void setHeaderString(String header);
56      /***
57       * Returns the header of the specified property
58       * @param index int
59       * @return String
60       */
61      public String getHeader(int index);
62  }