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.jsp.search.result;
029
030import org.opencms.jsp.util.CmsJspContentAccessBean;
031import org.opencms.search.CmsSearchResource;
032
033import java.util.Date;
034import java.util.List;
035import java.util.Map;
036
037/**
038* @return
039*/
040
041/** Interface for a single search result, as wrapped JSP EL friendly. */
042public interface I_CmsSearchResourceBean {
043
044    /** Returns the map from field names to field values for date fields.
045     * @return The map from field names to field values for date fields.
046     */
047    Map<String, Date> getDateFields();
048
049    /** Returns the map from field names to field values for string fields.
050     * @return The map from field names to field values for string fields.
051     */
052    Map<String, String> getFields();
053
054    /** Returns the map from field names to field values for multi-valued (string) fields.
055     * @return The map from field names to field values for multi-valued (string) fields.
056     */
057    Map<String, List<String>> getMultiValuedFields();
058
059    /** Returns the wrapped CmsSearchResource (to access the CmsResource).
060     * @return The wrapped CmsSearchResource.
061     */
062    CmsSearchResource getSearchResource();
063
064    /** Reads the resource and allows content access in the current request language - in case of an XML content.
065     * If the resource is not an XML content, it returns null.
066     * @return The XML content or null.
067     */
068    CmsJspContentAccessBean getXmlContent();
069
070    /** Reads the resource and allows content access in the specified language - in case of an XML content.
071     * If the resource is not an XML content, it returns null.
072     * @return The XML content or null.
073     */
074    Map<String, CmsJspContentAccessBean> getXmlContentInLocale();
075}