001    /**
002     * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.layoutsadmin.util;
016    
017    import com.liferay.portal.kernel.exception.PortalException;
018    import com.liferay.portal.kernel.util.UnicodeProperties;
019    import com.liferay.portal.kernel.xml.Element;
020    import com.liferay.portal.model.Layout;
021    import com.liferay.portal.theme.ThemeDisplay;
022    
023    import java.util.Date;
024    import java.util.Locale;
025    import java.util.Map;
026    
027    /**
028     * @author Raymond Aug??
029     */
030    public interface Sitemap {
031    
032            public void addURLElement(
033                    Element element, String url, UnicodeProperties typeSettingsProperties,
034                    Date modifiedDate, String canonicalURL,
035                    Map<Locale, String> alternateURLs);
036    
037            public String encodeXML(String input);
038    
039            public Map<Locale, String> getAlternateURLs(
040                            String canonicalURL, ThemeDisplay themeDisplay, Layout layout)
041                    throws PortalException;
042    
043            public String getSitemap(
044                            long groupId, boolean privateLayout, ThemeDisplay themeDisplay)
045                    throws PortalException;
046    
047    }