1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.model;
24  
25  
26  /**
27   * <a href="Layout.java.html"><b><i>View Source</i></b></a>
28   *
29   * <p>
30   * ServiceBuilder generated this class. Modifications in this class will be
31   * overwritten the next time is generated.
32   * </p>
33   *
34   * <p>
35   * This interface is a model that represents the Layout table in the
36   * database.
37   * </p>
38   *
39   * <p>
40   * Customize {@link com.liferay.portal.model.impl.LayoutImpl} and rerun the
41   * ServiceBuilder to generate the new methods.
42   * </p>
43   *
44   * @author    Brian Wing Shun Chan
45   * @see       LayoutModel
46   * @see       com.liferay.portal.model.impl.LayoutImpl
47   * @see       com.liferay.portal.model.impl.LayoutModelImpl
48   * @generated
49   */
50  public interface Layout extends LayoutModel {
51      public com.liferay.portal.model.Group getGroup();
52  
53      public com.liferay.portal.model.Group getScopeGroup()
54          throws com.liferay.portal.PortalException,
55              com.liferay.portal.SystemException;
56  
57      public boolean hasScopeGroup()
58          throws com.liferay.portal.PortalException,
59              com.liferay.portal.SystemException;
60  
61      public boolean isPublicLayout();
62  
63      public long getAncestorPlid();
64  
65      public long getAncestorLayoutId();
66  
67      public java.util.List<com.liferay.portal.model.Layout> getAncestors()
68          throws com.liferay.portal.PortalException,
69              com.liferay.portal.SystemException;
70  
71      public boolean hasAncestor(long layoutId)
72          throws com.liferay.portal.PortalException,
73              com.liferay.portal.SystemException;
74  
75      public boolean isFirstParent();
76  
77      public boolean isFirstChild();
78  
79      public boolean isRootLayout();
80  
81      public java.util.List<com.liferay.portal.model.Layout> getChildren()
82          throws com.liferay.portal.SystemException;
83  
84      public java.util.List<com.liferay.portal.model.Layout> getAllChildren()
85          throws com.liferay.portal.SystemException;
86  
87      public java.util.List<com.liferay.portal.model.Layout> getChildren(
88          com.liferay.portal.security.permission.PermissionChecker permissionChecker)
89          throws com.liferay.portal.PortalException,
90              com.liferay.portal.SystemException;
91  
92      public java.lang.String getName(java.util.Locale locale);
93  
94      public java.lang.String getName(java.lang.String localeLanguageId);
95  
96      public java.lang.String getName(java.util.Locale locale, boolean useDefault);
97  
98      public java.lang.String getName(java.lang.String localeLanguageId,
99          boolean useDefault);
100 
101     public void setName(java.lang.String name, java.util.Locale locale);
102 
103     public java.lang.String getTitle(java.util.Locale locale);
104 
105     public java.lang.String getTitle(java.lang.String localeLanguageId);
106 
107     public java.lang.String getTitle(java.util.Locale locale, boolean useDefault);
108 
109     public java.lang.String getTitle(java.lang.String localeLanguageId,
110         boolean useDefault);
111 
112     public java.lang.String getHTMLTitle(java.util.Locale locale);
113 
114     public java.lang.String getHTMLTitle(java.lang.String localeLanguageId);
115 
116     public void setTitle(java.lang.String title, java.util.Locale locale);
117 
118     public com.liferay.portal.model.LayoutType getLayoutType();
119 
120     public java.lang.String getTypeSettings();
121 
122     public void setTypeSettings(java.lang.String typeSettings);
123 
124     public com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties();
125 
126     public void setTypeSettingsProperties(
127         com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties);
128 
129     public com.liferay.portal.model.LayoutSet getLayoutSet();
130 
131     public boolean isInheritLookAndFeel();
132 
133     public com.liferay.portal.model.Theme getTheme()
134         throws com.liferay.portal.SystemException;
135 
136     public com.liferay.portal.model.ColorScheme getColorScheme()
137         throws com.liferay.portal.SystemException;
138 
139     public boolean isInheritWapLookAndFeel();
140 
141     public com.liferay.portal.model.Theme getWapTheme()
142         throws com.liferay.portal.SystemException;
143 
144     public com.liferay.portal.model.ColorScheme getWapColorScheme()
145         throws com.liferay.portal.SystemException;
146 
147     public java.lang.String getCssText();
148 
149     public java.lang.String getRegularURL(
150         javax.servlet.http.HttpServletRequest request)
151         throws com.liferay.portal.SystemException;
152 
153     public java.lang.String getResetMaxStateURL(
154         javax.servlet.http.HttpServletRequest request)
155         throws com.liferay.portal.SystemException;
156 
157     public java.lang.String getResetLayoutURL(
158         javax.servlet.http.HttpServletRequest request)
159         throws com.liferay.portal.SystemException;
160 
161     public java.lang.String getTarget();
162 
163     public boolean isChildSelected(boolean selectable,
164         com.liferay.portal.model.Layout layout);
165 
166     public boolean isSelected(boolean selectable,
167         com.liferay.portal.model.Layout layout, long ancestorPlid);
168 }