View Javadoc

1   /**
2    * This file Copyright (c) 2003-2012 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.forum;
35  
36  import java.util.List;
37  
38  import javax.jcr.Node;
39  
40  /**
41   * A simple bean holding the results of a paged query.
42   * @see info.magnolia.module.forum.Pager
43   *
44   * @author gjoseph
45   * @version $Revision: $ ($Author: $)
46   */
47  public class PagedResult {
48      private final List<Node> nodePage;
49      private final long totalNodeCount;
50  
51      public PagedResult(List<Node> nodePage, long totalNodeCount) {
52          this.nodePage = nodePage;
53          this.totalNodeCount = totalNodeCount;
54      }
55  
56      /**
57       * @return the requested page of nodes. (i.e a range in the results of the query)
58       */
59      public List<Node> getNodePage() {
60          return nodePage;
61      }
62  
63      /**
64       * @return the total number of nodes returned by the query.
65       */
66      public long getTotalNodeCount() {
67          return totalNodeCount;
68      }
69  }