I_CmsXmlContentContainer


1   /*
2    * File   : $Source: /usr/local/cvs/opencms/src/org/opencms/jsp/I_CmsXmlContentContainer.java,v $
3    * Date   : $Date: 2006/03/27 14:52:19 $
4    * Version: $Revision: 1.2 $
5    *
6    * This library is part of OpenCms -
7    * the Open Source Content Mananagement System
8    *
9    * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10   *
11   * This library is free software; you can redistribute it and/or
12   * modify it under the terms of the GNU Lesser General Public
13   * License as published by the Free Software Foundation; either
14   * version 2.1 of the License, or (at your option) any later version.
15   *
16   * This library is distributed in the hope that it will be useful,
17   * but WITHOUT ANY WARRANTY; without even the implied warranty of
18   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19   * Lesser General Public License for more details.
20   *
21   * For further information about Alkacon Software GmbH, please see the
22   * company website: http://www.alkacon.com
23   *
24   * For further information about OpenCms, please see the
25   * project website: http://www.opencms.org
26   * 
27   * You should have received a copy of the GNU Lesser General Public
28   * License along with this library; if not, write to the Free Software
29   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30   */
31  
32  package org.opencms.jsp;
33  
34  import org.opencms.xml.I_CmsXmlDocument;
35  
36  import java.util.List  ;
37  import java.util.Locale  ;
38  
39  import javax.servlet.jsp.JspException  ;
40  
41  /**
42   * Provides access to a <code>{@link org.opencms.xml.I_CmsXmlDocument}</code> document that was previously loaded by a parent tag.<p> 
43   * 
44   * @version $Revision: 1.2 $ 
45   * 
46   * @since 6.2.0 
47   */
48  public interface I_CmsXmlContentContainer {
49  
50      /**
51       * Returns the name of the currently used XML content collector.<p>
52       * 
53       * @return the name of the currently used XML content collector
54       */
55      String   getCollectorName();
56  
57      /**
58       * Returns the parameters of the currently used XML content collector.<p>
59       * 
60       * @return the parameters of the currently used XML content collector
61       */
62      String   getCollectorParam();
63  
64      /**
65       * Returns the list of all currently loaded XML content documents (instances of <code>{@link I_CmsXmlDocument}</code>).<p>
66       * 
67       * @return the list of all currently loaded XML content documents
68       */
69      List   getCollectorResult();
70  
71      /**
72       * Returns the resource name in the VFS for the currently loaded XML content document.<p>
73       *
74       * @return the resource name in the VFS for the currently loaded XML content document
75       */
76      String   getResourceName();
77  
78      /**
79       * Returns the currently loaded OpenCms XML content document.<p>
80       *
81       * @return the currently loaded OpenCms XML content document
82       */
83      I_CmsXmlDocument getXmlDocument();
84  
85      /**
86       * Returns the currently selected element name in the loaded XML content document.<p>
87       * 
88       * @return the currently selected element name in the loaded XML content document
89       */
90      String   getXmlDocumentElement();
91  
92      /**
93       * Returns the currently selected locale used for acessing the content in the loaded XML content document.<p>
94       * 
95       * @return the currently selected locale used for acessing the content in the loaded XML content document
96       */
97      Locale   getXmlDocumentLocale();
98  
99      /**
100      * Content iteration method to be used by JSP scriptlet code.<p>
101      * 
102      * Calling this method will insert "direct edit" HTML to the output page (if required).<p>
103      * 
104      * @return <code>true</code> if more content is to be iterated
105      * 
106      * @throws JspException in case something goes wrong
107      */
108     boolean hasMoreContent() throws JspException  ;
109 
110     /**
111      * Returns <code>true</code> if this container is used as a content preloader.<p> 
112      * 
113      * A content preloader is used to load content without looping through it.<p> 
114      * 
115      * @return <code>true</code> if this container is used as a content preloader
116      */
117     boolean isPreloader();
118 }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags