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