001    /**
002     * Copyright (c) 2000-2013 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    import com.liferay.portal.kernel.util.Accessor;
018    
019    /**
020     * The extended model interface for the Layout service. Represents a row in the "Layout" database table, with each column mapped to a property of this class.
021     *
022     * @author Brian Wing Shun Chan
023     * @see LayoutModel
024     * @see com.liferay.portal.model.impl.LayoutImpl
025     * @see com.liferay.portal.model.impl.LayoutModelImpl
026     * @generated
027     */
028    public interface Layout extends LayoutModel, PersistedModel {
029            /*
030             * NOTE FOR DEVELOPERS:
031             *
032             * 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.
033             */
034            public static final Accessor<Layout, Long> LAYOUT_ID_ACCESSOR = new Accessor<Layout, Long>() {
035                            public Long get(Layout layout) {
036                                    return layout.getLayoutId();
037                            }
038                    };
039    
040            public java.util.List<com.liferay.portal.model.Layout> getAllChildren()
041                    throws com.liferay.portal.kernel.exception.SystemException;
042    
043            public long getAncestorLayoutId()
044                    throws com.liferay.portal.kernel.exception.PortalException,
045                            com.liferay.portal.kernel.exception.SystemException;
046    
047            public long getAncestorPlid()
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> getAncestors()
052                    throws com.liferay.portal.kernel.exception.PortalException,
053                            com.liferay.portal.kernel.exception.SystemException;
054    
055            public java.util.List<com.liferay.portal.model.Layout> getChildren()
056                    throws com.liferay.portal.kernel.exception.SystemException;
057    
058            public java.util.List<com.liferay.portal.model.Layout> getChildren(
059                    com.liferay.portal.security.permission.PermissionChecker permissionChecker)
060                    throws com.liferay.portal.kernel.exception.PortalException,
061                            com.liferay.portal.kernel.exception.SystemException;
062    
063            public com.liferay.portal.model.ColorScheme getColorScheme()
064                    throws com.liferay.portal.kernel.exception.PortalException,
065                            com.liferay.portal.kernel.exception.SystemException;
066    
067            public java.lang.String getCssText()
068                    throws com.liferay.portal.kernel.exception.PortalException,
069                            com.liferay.portal.kernel.exception.SystemException;
070    
071            public com.liferay.portal.model.Group getGroup()
072                    throws com.liferay.portal.kernel.exception.PortalException,
073                            com.liferay.portal.kernel.exception.SystemException;
074    
075            public java.lang.String getHTMLTitle(java.util.Locale locale);
076    
077            public java.lang.String getHTMLTitle(java.lang.String localeLanguageId);
078    
079            public com.liferay.portal.model.LayoutSet getLayoutSet()
080                    throws com.liferay.portal.kernel.exception.PortalException,
081                            com.liferay.portal.kernel.exception.SystemException;
082    
083            public com.liferay.portal.model.LayoutType getLayoutType();
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 getThemeSetting(java.lang.String key,
115                    java.lang.String device);
116    
117            public java.lang.String getTypeSettings();
118    
119            public com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties();
120    
121            public java.lang.String getTypeSettingsProperty(java.lang.String key);
122    
123            public java.lang.String getTypeSettingsProperty(java.lang.String key,
124                    java.lang.String defaultValue);
125    
126            public com.liferay.portal.model.ColorScheme getWapColorScheme()
127                    throws com.liferay.portal.kernel.exception.PortalException,
128                            com.liferay.portal.kernel.exception.SystemException;
129    
130            public com.liferay.portal.model.Theme getWapTheme()
131                    throws com.liferay.portal.kernel.exception.PortalException,
132                            com.liferay.portal.kernel.exception.SystemException;
133    
134            public boolean hasAncestor(long layoutId)
135                    throws com.liferay.portal.kernel.exception.PortalException,
136                            com.liferay.portal.kernel.exception.SystemException;
137    
138            public boolean hasChildren()
139                    throws com.liferay.portal.kernel.exception.SystemException;
140    
141            public boolean hasScopeGroup()
142                    throws com.liferay.portal.kernel.exception.PortalException,
143                            com.liferay.portal.kernel.exception.SystemException;
144    
145            public boolean isChildSelected(boolean selectable,
146                    com.liferay.portal.model.Layout layout)
147                    throws com.liferay.portal.kernel.exception.PortalException,
148                            com.liferay.portal.kernel.exception.SystemException;
149    
150            public boolean isContentDisplayPage();
151    
152            public boolean isFirstChild();
153    
154            public boolean isFirstParent();
155    
156            public boolean isInheritLookAndFeel();
157    
158            public boolean isInheritWapLookAndFeel();
159    
160            public boolean isLayoutPrototypeLinkActive();
161    
162            public boolean isPublicLayout();
163    
164            public boolean isRootLayout();
165    
166            public boolean isSelected(boolean selectable,
167                    com.liferay.portal.model.Layout layout, long ancestorPlid);
168    
169            public boolean isTypeArticle();
170    
171            public boolean isTypeControlPanel();
172    
173            public boolean isTypeEmbedded();
174    
175            public boolean isTypeLinkToLayout();
176    
177            public boolean isTypePanel();
178    
179            public boolean isTypePortlet();
180    
181            public boolean isTypeURL();
182    
183            public void setGroupId(long groupId);
184    
185            public void setLayoutSet(com.liferay.portal.model.LayoutSet layoutSet);
186    
187            public void setPrivateLayout(boolean privateLayout);
188    
189            public void setTypeSettings(java.lang.String typeSettings);
190    
191            public void setTypeSettingsProperties(
192                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties);
193    }