001: /*
002: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/jsp/decorator/I_CmsDecoratorConfiguration.java,v $
003: * Date : $Date: 2008-03-14 14:29:56 $
004: * Version: $Revision: 1.2 $
005: *
006: * This library is part of OpenCms -
007: * the Open Source Content Management System
008: *
009: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
010: *
011: * This library is free software; you can redistribute it and/or
012: * modify it under the terms of the GNU Lesser General Public
013: * License as published by the Free Software Foundation; either
014: * version 2.1 of the License, or (at your option) any later version.
015: *
016: * This library is distributed in the hope that it will be useful,
017: * but WITHOUT ANY WARRANTY; without even the implied warranty of
018: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019: * Lesser General Public License for more details.
020: *
021: * For further information about Alkacon Software GmbH, please see the
022: * company website: http://www.alkacon.com
023: *
024: * For further information about OpenCms, please see the
025: * project website: http://www.opencms.org
026: *
027: * You should have received a copy of the GNU Lesser General Public
028: * License along with this library; if not, write to the Free Software
029: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
030: */
031:
032: package org.opencms.jsp.decorator;
033:
034: import org.opencms.file.CmsObject;
035: import org.opencms.main.CmsException;
036: import org.opencms.xml.content.CmsXmlContent;
037:
038: import java.util.Locale;
039:
040: /**
041: * Interface for a CmsDecoratorConfiguration.<p>
042: *
043: * This interface describes a CmsDecoratorConfiguration which provides methods to
044: * get a filled CmsDecorationBundle. A decoration bundle contains a datastructure
045: * of text decorations which can be used in the current request context.
046: *
047: * @author Michael Emmerich
048: *
049: */
050: public interface I_CmsDecoratorConfiguration {
051:
052: /**
053: * Builds a CmsDecorationDefintion from a given configuration file.<p>
054: *
055: * @param configuration the configuration file
056: * @param i the number of the decoration definition to create
057: * @return CmsDecorationDefintion created form configuration file
058: */
059: CmsDecorationDefintion getDecorationDefinition(
060: CmsXmlContent configuration, int i);
061:
062: /**
063: * Gets the decoration bundle.<p>
064: *@return the decoration bundle to be used
065: */
066: CmsDecorationBundle getDecorations();
067:
068: /**
069: * Tests if a decoration key was used before in this configuration.<p>
070: * @param key the key to look for
071: * @return true if this key was already used
072: */
073: boolean hasUsed(String key);
074:
075: /**
076: * Initialises the configuration.<p>
077: *
078: *@param cms the CmsObject
079: * @param configFile the configuration file
080: * @param locale to locale to build this configuration for
081: * @throws CmsException if something goes wrong
082: */
083: void init(CmsObject cms, String configFile, Locale locale)
084: throws CmsException;
085:
086: /**
087: * Tests if a tag is contained in the exclude list of the decorator.<p>
088: *
089: * @param tag the tag to test
090: * @return true if the tag is in the exclode list, false othwerwise.
091: */
092: boolean isExcluded(String tag);
093:
094: /**
095: * Mark a decoration key as already used.<p>
096: * @param key the key to mark
097: */
098: void markAsUsed(String key);
099:
100: /**
101: * Resets the used decoration keys.<p>
102: */
103: void resetMarkedDecorations();
104: }
|