View Javadoc

1   /*
2    * $Id: ISortComparatorCapability.java,v 1.18 2011/06/16 09:29:40 jbmeslin Exp $
3    * 
4    */
5   package org.rcfaces.core.component.capability;
6   
7   import java.util.Comparator;
8   
9   /**
10   * A string value specifying the "compare" function to use. it can reference a
11   * javascript function or a keyword :
12   * <ul>
13   * <li> integer </li>
14   * <li> number </li>
15   * <li> alpha </li>
16   * <li> alphaIgnoreCase </li>
17   * <li> time </li>
18   * <li> date </li>
19   * <li> &lt;javascript function&gt; </li>
20   * </ul>
21   * 
22   * @author Olivier Oeuillot (latest modification by $Author: jbmeslin $)
23   * @version $Revision: 1.18 $ $Date: 2011/06/16 09:29:40 $
24   */
25  public interface ISortComparatorCapability {
26  
27      /**
28       * Returns the sort Comparator object associated with the component
29       * 
30       * @return the sort Comparator object
31       */
32      Comparator getSortComparator();
33  
34      /**
35       * Associates a sort Comparator object to the component.
36       * 
37       * @param sortComparator
38       *            the sort Comparator object
39       */
40      void setSortComparator(Comparator sortComparator);
41  }