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