001    /**
002     * Copyright (c) 2000-2010 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.portal.model;
016    
017    
018    /**
019     * <p>
020     * This interface is a model that represents the Layout table in the
021     * database.
022     * </p>
023     *
024     * <p>
025     * Customize {@link com.liferay.portal.model.impl.LayoutImpl} and rerun the
026     * ServiceBuilder to generate the new methods.
027     * </p>
028     *
029     * @author    Brian Wing Shun Chan
030     * @see       LayoutModel
031     * @see       com.liferay.portal.model.impl.LayoutImpl
032     * @see       com.liferay.portal.model.impl.LayoutModelImpl
033     * @generated
034     */
035    public interface Layout extends LayoutModel {
036            public java.util.List<com.liferay.portal.model.Layout> getAllChildren()
037                    throws com.liferay.portal.kernel.exception.SystemException;
038    
039            public long getAncestorLayoutId()
040                    throws com.liferay.portal.kernel.exception.PortalException,
041                            com.liferay.portal.kernel.exception.SystemException;
042    
043            public long getAncestorPlid()
044                    throws com.liferay.portal.kernel.exception.PortalException,
045                            com.liferay.portal.kernel.exception.SystemException;
046    
047            public java.util.List<com.liferay.portal.model.Layout> getAncestors()
048                    throws com.liferay.portal.kernel.exception.PortalException,
049                            com.liferay.portal.kernel.exception.SystemException;
050    
051            public java.util.List<com.liferay.portal.model.Layout> getChildren()
052                    throws com.liferay.portal.kernel.exception.SystemException;
053    
054            public java.util.List<com.liferay.portal.model.Layout> getChildren(
055                    com.liferay.portal.security.permission.PermissionChecker permissionChecker)
056                    throws com.liferay.portal.kernel.exception.PortalException,
057                            com.liferay.portal.kernel.exception.SystemException;
058    
059            public com.liferay.portal.model.ColorScheme getColorScheme()
060                    throws com.liferay.portal.kernel.exception.PortalException,
061                            com.liferay.portal.kernel.exception.SystemException;
062    
063            public java.lang.String getCssText()
064                    throws com.liferay.portal.kernel.exception.PortalException,
065                            com.liferay.portal.kernel.exception.SystemException;
066    
067            public com.liferay.portal.model.Group getGroup()
068                    throws com.liferay.portal.kernel.exception.PortalException,
069                            com.liferay.portal.kernel.exception.SystemException;
070    
071            public java.lang.String getHTMLTitle(java.util.Locale locale);
072    
073            public java.lang.String getHTMLTitle(java.lang.String localeLanguageId);
074    
075            public com.liferay.portal.model.LayoutSet getLayoutSet()
076                    throws com.liferay.portal.kernel.exception.PortalException,
077                            com.liferay.portal.kernel.exception.SystemException;
078    
079            public com.liferay.portal.model.LayoutType getLayoutType();
080    
081            public java.lang.String getName(java.util.Locale locale);
082    
083            public java.lang.String getName(java.util.Locale locale, boolean useDefault);
084    
085            public java.lang.String getName(java.lang.String localeLanguageId);
086    
087            public java.lang.String getName(java.lang.String localeLanguageId,
088                    boolean useDefault);
089    
090            public long getParentPlid()
091                    throws com.liferay.portal.kernel.exception.PortalException,
092                            com.liferay.portal.kernel.exception.SystemException;
093    
094            public java.lang.String getRegularURL(
095                    javax.servlet.http.HttpServletRequest request)
096                    throws com.liferay.portal.kernel.exception.PortalException,
097                            com.liferay.portal.kernel.exception.SystemException;
098    
099            public java.lang.String getResetLayoutURL(
100                    javax.servlet.http.HttpServletRequest request)
101                    throws com.liferay.portal.kernel.exception.PortalException,
102                            com.liferay.portal.kernel.exception.SystemException;
103    
104            public java.lang.String getResetMaxStateURL(
105                    javax.servlet.http.HttpServletRequest request)
106                    throws com.liferay.portal.kernel.exception.PortalException,
107                            com.liferay.portal.kernel.exception.SystemException;
108    
109            public com.liferay.portal.model.Group getScopeGroup()
110                    throws com.liferay.portal.kernel.exception.PortalException,
111                            com.liferay.portal.kernel.exception.SystemException;
112    
113            public java.lang.String getTarget();
114    
115            public com.liferay.portal.model.Theme getTheme()
116                    throws com.liferay.portal.kernel.exception.PortalException,
117                            com.liferay.portal.kernel.exception.SystemException;
118    
119            public java.lang.String getTitle(java.util.Locale locale);
120    
121            public java.lang.String getTitle(java.util.Locale locale, boolean useDefault);
122    
123            public java.lang.String getTitle(java.lang.String localeLanguageId);
124    
125            public java.lang.String getTitle(java.lang.String localeLanguageId,
126                    boolean useDefault);
127    
128            public java.lang.String getTypeSettings();
129    
130            public com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties();
131    
132            public com.liferay.portal.model.ColorScheme getWapColorScheme()
133                    throws com.liferay.portal.kernel.exception.PortalException,
134                            com.liferay.portal.kernel.exception.SystemException;
135    
136            public com.liferay.portal.model.Theme getWapTheme()
137                    throws com.liferay.portal.kernel.exception.PortalException,
138                            com.liferay.portal.kernel.exception.SystemException;
139    
140            public boolean hasAncestor(long layoutId)
141                    throws com.liferay.portal.kernel.exception.PortalException,
142                            com.liferay.portal.kernel.exception.SystemException;
143    
144            public boolean hasChildren()
145                    throws com.liferay.portal.kernel.exception.SystemException;
146    
147            public boolean hasScopeGroup()
148                    throws com.liferay.portal.kernel.exception.PortalException,
149                            com.liferay.portal.kernel.exception.SystemException;
150    
151            public boolean isChildSelected(boolean selectable,
152                    com.liferay.portal.model.Layout layout)
153                    throws com.liferay.portal.kernel.exception.PortalException,
154                            com.liferay.portal.kernel.exception.SystemException;
155    
156            public boolean isFirstChild();
157    
158            public boolean isFirstParent();
159    
160            public boolean isInheritLookAndFeel();
161    
162            public boolean isInheritWapLookAndFeel();
163    
164            public boolean isPublicLayout();
165    
166            public boolean isRootLayout();
167    
168            public boolean isSelected(boolean selectable,
169                    com.liferay.portal.model.Layout layout, long ancestorPlid);
170    
171            public boolean isTypeArticle();
172    
173            public boolean isTypeControlPanel();
174    
175            public boolean isTypeEmbedded();
176    
177            public boolean isTypeLinkToLayout();
178    
179            public boolean isTypePanel();
180    
181            public boolean isTypePortlet();
182    
183            public boolean isTypeURL();
184    
185            public void setName(java.lang.String name, java.util.Locale locale);
186    
187            public void setTitle(java.lang.String title, java.util.Locale locale);
188    
189            public void setTypeSettings(java.lang.String typeSettings);
190    
191            public void setTypeSettingsProperties(
192                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties);
193    }