1 /** 2 * This file Copyright (c) 2003-2010 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.cms.i18n; 35 36 import java.util.Collection; 37 import java.util.Locale; 38 39 import info.magnolia.cms.core.Content; 40 import info.magnolia.cms.core.NodeData; 41 42 import javax.jcr.RepositoryException; 43 44 45 /** 46 * Support for i18n content. Used to rewrite uris and getting nodedatas based on the current language. 47 * @author philipp 48 * @version $Id: I18nContentSupport.java 36517 2010-08-18 15:25:06Z pbaerfuss $ 49 */ 50 public interface I18nContentSupport { 51 52 /** 53 * Get the current locale used for rendering content. 54 */ 55 public Locale getLocale(); 56 57 public void setLocale(Locale locale); 58 59 /** 60 * The default locale to be used. Can be used to fix the system to a certain language. 61 */ 62 public Locale getFallbackLocale(); 63 64 public void setFallbackLocale(Locale fallbackLocale); 65 66 /** 67 * Transform the internal uri to a i18n uri. This method may add a prefix or suffix 68 */ 69 public String toI18NURI(String uri); 70 71 /** 72 * Remove all i18n tokens form the uri. The uri can then be used to get the content. 73 */ 74 public String toRawURI(String i18nURI); 75 76 /** 77 * This method uses the current agregation state to set the locale used for the rendering process . 78 */ 79 public Locale determineLocale(); 80 81 /** 82 * Returns the NodeData object based on the language passes. 83 */ 84 public NodeData getNodeData(Content node, String name, Locale locale) throws RepositoryException; 85 86 /** 87 * Returns the NodeData object based on the current language. 88 */ 89 public NodeData getNodeData(Content node, String name); 90 91 /** 92 * Returns the available locales. 93 */ 94 public Collection<Locale> getLocales(); 95 96 public boolean isEnabled(); 97 98 }