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                            @Override
036                            public Long get(Layout layout) {
037                                    return layout.getLayoutId();
038                            }
039                    };
040    
041            public java.util.List<com.liferay.portal.model.Layout> getAllChildren()
042                    throws com.liferay.portal.kernel.exception.SystemException;
043    
044            public long getAncestorLayoutId()
045                    throws com.liferay.portal.kernel.exception.PortalException,
046                            com.liferay.portal.kernel.exception.SystemException;
047    
048            public long getAncestorPlid()
049                    throws com.liferay.portal.kernel.exception.PortalException,
050                            com.liferay.portal.kernel.exception.SystemException;
051    
052            public java.util.List<com.liferay.portal.model.Layout> getAncestors()
053                    throws com.liferay.portal.kernel.exception.PortalException,
054                            com.liferay.portal.kernel.exception.SystemException;
055    
056            public java.util.List<com.liferay.portal.model.Layout> getChildren()
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            public java.util.List<com.liferay.portal.model.Layout> getChildren(
060                    com.liferay.portal.security.permission.PermissionChecker permissionChecker)
061                    throws com.liferay.portal.kernel.exception.PortalException,
062                            com.liferay.portal.kernel.exception.SystemException;
063    
064            public com.liferay.portal.model.ColorScheme getColorScheme()
065                    throws com.liferay.portal.kernel.exception.PortalException,
066                            com.liferay.portal.kernel.exception.SystemException;
067    
068            public java.lang.String getCssText()
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException;
071    
072            public java.lang.String getFriendlyURL(java.util.Locale locale);
073    
074            public java.util.Map<java.util.Locale, java.lang.String> getFriendlyURLMap()
075                    throws com.liferay.portal.kernel.exception.SystemException;
076    
077            public java.lang.String getFriendlyURLsXML()
078                    throws com.liferay.portal.kernel.exception.SystemException;
079    
080            public com.liferay.portal.model.Group getGroup()
081                    throws com.liferay.portal.kernel.exception.PortalException,
082                            com.liferay.portal.kernel.exception.SystemException;
083    
084            public java.lang.String getHTMLTitle(java.util.Locale locale);
085    
086            public java.lang.String getHTMLTitle(java.lang.String localeLanguageId);
087    
088            public com.liferay.portal.model.LayoutSet getLayoutSet()
089                    throws com.liferay.portal.kernel.exception.PortalException,
090                            com.liferay.portal.kernel.exception.SystemException;
091    
092            public com.liferay.portal.model.LayoutType getLayoutType();
093    
094            public long getParentPlid()
095                    throws com.liferay.portal.kernel.exception.PortalException,
096                            com.liferay.portal.kernel.exception.SystemException;
097    
098            public java.lang.String getRegularURL(
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 getResetLayoutURL(
104                    javax.servlet.http.HttpServletRequest request)
105                    throws com.liferay.portal.kernel.exception.PortalException,
106                            com.liferay.portal.kernel.exception.SystemException;
107    
108            public java.lang.String getResetMaxStateURL(
109                    javax.servlet.http.HttpServletRequest request)
110                    throws com.liferay.portal.kernel.exception.PortalException,
111                            com.liferay.portal.kernel.exception.SystemException;
112    
113            public com.liferay.portal.model.Group getScopeGroup()
114                    throws com.liferay.portal.kernel.exception.PortalException,
115                            com.liferay.portal.kernel.exception.SystemException;
116    
117            public java.lang.String getTarget();
118    
119            public com.liferay.portal.model.Theme getTheme()
120                    throws com.liferay.portal.kernel.exception.PortalException,
121                            com.liferay.portal.kernel.exception.SystemException;
122    
123            public java.lang.String getThemeSetting(java.lang.String key,
124                    java.lang.String device);
125    
126            public com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties();
127    
128            public java.lang.String getTypeSettingsProperty(java.lang.String key);
129    
130            public java.lang.String getTypeSettingsProperty(java.lang.String key,
131                    java.lang.String defaultValue);
132    
133            public com.liferay.portal.model.ColorScheme getWapColorScheme()
134                    throws com.liferay.portal.kernel.exception.PortalException,
135                            com.liferay.portal.kernel.exception.SystemException;
136    
137            public com.liferay.portal.model.Theme getWapTheme()
138                    throws com.liferay.portal.kernel.exception.PortalException,
139                            com.liferay.portal.kernel.exception.SystemException;
140    
141            public boolean hasAncestor(long layoutId)
142                    throws com.liferay.portal.kernel.exception.PortalException,
143                            com.liferay.portal.kernel.exception.SystemException;
144    
145            public boolean hasChildren()
146                    throws com.liferay.portal.kernel.exception.SystemException;
147    
148            public boolean hasScopeGroup()
149                    throws com.liferay.portal.kernel.exception.PortalException,
150                            com.liferay.portal.kernel.exception.SystemException;
151    
152            public boolean isChildSelected(boolean selectable,
153                    com.liferay.portal.model.Layout layout)
154                    throws com.liferay.portal.kernel.exception.PortalException,
155                            com.liferay.portal.kernel.exception.SystemException;
156    
157            public boolean isContentDisplayPage();
158    
159            public boolean isFirstChild();
160    
161            public boolean isFirstParent();
162    
163            public boolean isInheritLookAndFeel();
164    
165            public boolean isInheritWapLookAndFeel();
166    
167            public boolean isLayoutPrototypeLinkActive();
168    
169            public boolean isPublicLayout();
170    
171            public boolean isRootLayout();
172    
173            public boolean isSelected(boolean selectable,
174                    com.liferay.portal.model.Layout layout, long ancestorPlid);
175    
176            public boolean isSupportsEmbeddedPortlets();
177    
178            public boolean isTypeArticle();
179    
180            public boolean isTypeControlPanel();
181    
182            public boolean isTypeEmbedded();
183    
184            public boolean isTypeLinkToLayout();
185    
186            public boolean isTypePanel();
187    
188            public boolean isTypePortlet();
189    
190            public boolean isTypeURL();
191    
192            public void setLayoutSet(com.liferay.portal.model.LayoutSet layoutSet);
193    
194            public void setTypeSettingsProperties(
195                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties);
196    }