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