001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.widgets.dataview;
029
030import java.util.ArrayList;
031import java.util.List;
032
033/**
034 * Represents the result of a search query returned by an implementation of I_CmsDataView.
035 *
036 * This contains both a list of result items and a total hit count for the given query.
037 */
038public class CmsDataViewResult {
039
040    /** The list of results. */
041    private List<I_CmsDataViewItem> m_resultItems;
042
043    /** The total hit count. */
044    private int m_hitCount;
045
046    /**
047     * Creates a new result.<p>
048     *
049     * @param items the list of result items
050     * @param hitCount the total hit count
051     */
052    public CmsDataViewResult(List<I_CmsDataViewItem> items, int hitCount) {
053        m_resultItems = new ArrayList<I_CmsDataViewItem>(items);
054        m_hitCount = hitCount;
055    }
056
057    /**
058     * Gets the total number of results, disregarding paging.
059     *
060     * This count should be as accurate as possible.
061     *
062     * @return the total hit count
063     */
064    public int getHitCount() {
065
066        return m_hitCount;
067    }
068
069    /**
070     * Gets the list of result items.<p>
071     *
072     * @return the list of result items
073     */
074    public List<I_CmsDataViewItem> getItems() {
075
076        return m_resultItems;
077    }
078
079}