ListModel


1   /**
2    *
3    * Magnolia and its source-code is licensed under the LGPL.
4    * You may copy, adapt, and redistribute this file for commercial or non-commercial use.
5    * When copying, adapting, or redistributing this document in keeping with the guidelines above,
6    * you are required to provide proper attribution to obinary.
7    * If you reproduce or distribute the document without making any substantive modifications to its content,
8    * please use the following attribution line:
9    *
10   * Copyright 1993-2006 obinary Ltd. (http://www.obinary.com) All rights reserved.
11   *
12   */
13  package info.magnolia.cms.gui.controlx.list;
14  
15  import java.util.Iterator  ;
16  
17  /**
18   * @author Sameer Charles $Id: ListModel.java 6341 2006-09-12 09:18:27Z philipp $
19   */
20  public interface ListModel { // extends Iterable { // jdl 1.5!
21  
22      /**
23       * implement Iterable
24       * @return iterator
25       */
26      public Iterator   iterator();
27  
28      /**
29       * Return the list model iterator
30       * @return
31       */
32      public ListModelIterator getListModelIterator();
33  
34      /**
35       * set sort on field name
36       * @param name
37       */
38      public void setSortBy(String   name);
39  
40      /**
41       * set sort on field name
42       * @param name
43       * @param order
44       */
45      public void setSortBy(String   name, String   order);
46  
47      /**
48       * set group on field name
49       * @param name
50       */
51      public void setGroupBy(String   name);
52  
53      /**
54       * set group on field name
55       * @param name
56       * @param order
57       */
58      public void setGroupBy(String   name, String   order);
59  
60      /**
61       * get sort on field name
62       * @return String field name
63       */
64      public String   getSortBy();
65  
66      /**
67       * get sort by ordering
68       * @return order ('ASCENDING' | 'DESCENDING')
69       */
70      public String   getSortByOrder();
71  
72      /**
73       * get group on field name
74       * @return String field name
75       */
76      public String   getGroupBy();
77  
78      /**
79       * get group by ordering
80       * @return order ('ASCENDING' | 'DESCENDING')
81       */
82      public String   getGroupByOrder();
83  
84  }
85
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags