1   /**
2    * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3    *
4    * This library is free software; you can redistribute it and/or modify it under
5    * the terms of the GNU Lesser General Public License as published by the Free
6    * Software Foundation; either version 2.1 of the License, or (at your option)
7    * any later version.
8    *
9    * This library is distributed in the hope that it will be useful, but WITHOUT
10   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11   * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
12   * details.
13   */
14  
15  package com.liferay.portal.model;
16  
17  
18  /**
19   * <a href="Layout.java.html"><b><i>View Source</i></b></a>
20   *
21   * <p>
22   * ServiceBuilder generated this class. Modifications in this class will be
23   * overwritten the next time is generated.
24   * </p>
25   *
26   * <p>
27   * This interface is a model that represents the Layout table in the
28   * database.
29   * </p>
30   *
31   * <p>
32   * Customize {@link com.liferay.portal.model.impl.LayoutImpl} and rerun the
33   * ServiceBuilder to generate the new methods.
34   * </p>
35   *
36   * @author    Brian Wing Shun Chan
37   * @see       LayoutModel
38   * @see       com.liferay.portal.model.impl.LayoutImpl
39   * @see       com.liferay.portal.model.impl.LayoutModelImpl
40   * @generated
41   */
42  public interface Layout extends LayoutModel {
43      public java.util.List<com.liferay.portal.model.Layout> getAllChildren()
44          throws com.liferay.portal.kernel.exception.SystemException;
45  
46      public long getAncestorLayoutId()
47          throws com.liferay.portal.kernel.exception.PortalException,
48              com.liferay.portal.kernel.exception.SystemException;
49  
50      public long getAncestorPlid()
51          throws com.liferay.portal.kernel.exception.PortalException,
52              com.liferay.portal.kernel.exception.SystemException;
53  
54      public java.util.List<com.liferay.portal.model.Layout> getAncestors()
55          throws com.liferay.portal.kernel.exception.PortalException,
56              com.liferay.portal.kernel.exception.SystemException;
57  
58      public java.util.List<com.liferay.portal.model.Layout> getChildren()
59          throws com.liferay.portal.kernel.exception.SystemException;
60  
61      public java.util.List<com.liferay.portal.model.Layout> getChildren(
62          com.liferay.portal.security.permission.PermissionChecker permissionChecker)
63          throws com.liferay.portal.kernel.exception.PortalException,
64              com.liferay.portal.kernel.exception.SystemException;
65  
66      public com.liferay.portal.model.ColorScheme getColorScheme()
67          throws com.liferay.portal.kernel.exception.PortalException,
68              com.liferay.portal.kernel.exception.SystemException;
69  
70      public java.lang.String getCssText()
71          throws com.liferay.portal.kernel.exception.PortalException,
72              com.liferay.portal.kernel.exception.SystemException;
73  
74      public com.liferay.portal.model.Group getGroup()
75          throws com.liferay.portal.kernel.exception.PortalException,
76              com.liferay.portal.kernel.exception.SystemException;
77  
78      public java.lang.String getHTMLTitle(java.util.Locale locale);
79  
80      public java.lang.String getHTMLTitle(java.lang.String localeLanguageId);
81  
82      public com.liferay.portal.model.LayoutSet getLayoutSet()
83          throws com.liferay.portal.kernel.exception.PortalException,
84              com.liferay.portal.kernel.exception.SystemException;
85  
86      public com.liferay.portal.model.LayoutType getLayoutType();
87  
88      public java.lang.String getName(java.util.Locale locale);
89  
90      public java.lang.String getName(java.util.Locale locale, boolean useDefault);
91  
92      public java.lang.String getName(java.lang.String localeLanguageId);
93  
94      public java.lang.String getName(java.lang.String localeLanguageId,
95          boolean useDefault);
96  
97      public java.lang.String getRegularURL(
98          javax.servlet.http.HttpServletRequest request)
99          throws com.liferay.portal.kernel.exception.PortalException,
100             com.liferay.portal.kernel.exception.SystemException;
101 
102     public java.lang.String getResetLayoutURL(
103         javax.servlet.http.HttpServletRequest request)
104         throws com.liferay.portal.kernel.exception.PortalException,
105             com.liferay.portal.kernel.exception.SystemException;
106 
107     public java.lang.String getResetMaxStateURL(
108         javax.servlet.http.HttpServletRequest request)
109         throws com.liferay.portal.kernel.exception.PortalException,
110             com.liferay.portal.kernel.exception.SystemException;
111 
112     public com.liferay.portal.model.Group getScopeGroup()
113         throws com.liferay.portal.kernel.exception.PortalException,
114             com.liferay.portal.kernel.exception.SystemException;
115 
116     public java.lang.String getTarget();
117 
118     public com.liferay.portal.model.Theme getTheme()
119         throws com.liferay.portal.kernel.exception.PortalException,
120             com.liferay.portal.kernel.exception.SystemException;
121 
122     public java.lang.String getTitle(java.util.Locale locale);
123 
124     public java.lang.String getTitle(java.util.Locale locale, boolean useDefault);
125 
126     public java.lang.String getTitle(java.lang.String localeLanguageId);
127 
128     public java.lang.String getTitle(java.lang.String localeLanguageId,
129         boolean useDefault);
130 
131     public java.lang.String getTypeSettings();
132 
133     public com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties();
134 
135     public com.liferay.portal.model.ColorScheme getWapColorScheme()
136         throws com.liferay.portal.kernel.exception.PortalException,
137             com.liferay.portal.kernel.exception.SystemException;
138 
139     public com.liferay.portal.model.Theme getWapTheme()
140         throws com.liferay.portal.kernel.exception.PortalException,
141             com.liferay.portal.kernel.exception.SystemException;
142 
143     public boolean hasAncestor(long layoutId)
144         throws com.liferay.portal.kernel.exception.PortalException,
145             com.liferay.portal.kernel.exception.SystemException;
146 
147     public boolean hasChildren()
148         throws com.liferay.portal.kernel.exception.SystemException;
149 
150     public boolean hasScopeGroup()
151         throws com.liferay.portal.kernel.exception.PortalException,
152             com.liferay.portal.kernel.exception.SystemException;
153 
154     public boolean isChildSelected(boolean selectable,
155         com.liferay.portal.model.Layout layout)
156         throws com.liferay.portal.kernel.exception.PortalException,
157             com.liferay.portal.kernel.exception.SystemException;
158 
159     public boolean isFirstChild();
160 
161     public boolean isFirstParent();
162 
163     public boolean isInheritLookAndFeel();
164 
165     public boolean isInheritWapLookAndFeel();
166 
167     public boolean isPublicLayout();
168 
169     public boolean isRootLayout();
170 
171     public boolean isSelected(boolean selectable,
172         com.liferay.portal.model.Layout layout, long ancestorPlid);
173 
174     public boolean isTypeArticle();
175 
176     public boolean isTypeControlPanel();
177 
178     public boolean isTypeEmbedded();
179 
180     public boolean isTypeLinkToLayout();
181 
182     public boolean isTypePanel();
183 
184     public boolean isTypePortlet();
185 
186     public boolean isTypeURL();
187 
188     public void setName(java.lang.String name, java.util.Locale locale);
189 
190     public void setTitle(java.lang.String title, java.util.Locale locale);
191 
192     public void setTypeSettings(java.lang.String typeSettings);
193 
194     public void setTypeSettingsProperties(
195         com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties);
196 }