1   /**
2    * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   *
12   * 
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.SystemException;
45  
46      public long getAncestorLayoutId();
47  
48      public long getAncestorPlid();
49  
50      public java.util.List<com.liferay.portal.model.Layout> getAncestors()
51          throws com.liferay.portal.PortalException,
52              com.liferay.portal.SystemException;
53  
54      public java.util.List<com.liferay.portal.model.Layout> getChildren()
55          throws com.liferay.portal.SystemException;
56  
57      public java.util.List<com.liferay.portal.model.Layout> getChildren(
58          com.liferay.portal.security.permission.PermissionChecker permissionChecker)
59          throws com.liferay.portal.PortalException,
60              com.liferay.portal.SystemException;
61  
62      public com.liferay.portal.model.ColorScheme getColorScheme()
63          throws com.liferay.portal.SystemException;
64  
65      public java.lang.String getCssText();
66  
67      public com.liferay.portal.model.Group getGroup();
68  
69      public java.lang.String getHTMLTitle(java.util.Locale locale);
70  
71      public java.lang.String getHTMLTitle(java.lang.String localeLanguageId);
72  
73      public com.liferay.portal.model.LayoutSet getLayoutSet();
74  
75      public com.liferay.portal.model.LayoutType getLayoutType();
76  
77      public java.lang.String getName(java.util.Locale locale);
78  
79      public java.lang.String getName(java.util.Locale locale, boolean useDefault);
80  
81      public java.lang.String getName(java.lang.String localeLanguageId);
82  
83      public java.lang.String getName(java.lang.String localeLanguageId,
84          boolean useDefault);
85  
86      public java.lang.String getRegularURL(
87          javax.servlet.http.HttpServletRequest request)
88          throws com.liferay.portal.SystemException;
89  
90      public java.lang.String getResetLayoutURL(
91          javax.servlet.http.HttpServletRequest request)
92          throws com.liferay.portal.SystemException;
93  
94      public java.lang.String getResetMaxStateURL(
95          javax.servlet.http.HttpServletRequest request)
96          throws com.liferay.portal.SystemException;
97  
98      public com.liferay.portal.model.Group getScopeGroup()
99          throws com.liferay.portal.PortalException,
100             com.liferay.portal.SystemException;
101 
102     public java.lang.String getTarget();
103 
104     public com.liferay.portal.model.Theme getTheme()
105         throws com.liferay.portal.SystemException;
106 
107     public java.lang.String getTitle(java.util.Locale locale);
108 
109     public java.lang.String getTitle(java.util.Locale locale, boolean useDefault);
110 
111     public java.lang.String getTitle(java.lang.String localeLanguageId);
112 
113     public java.lang.String getTitle(java.lang.String localeLanguageId,
114         boolean useDefault);
115 
116     public java.lang.String getTypeSettings();
117 
118     public com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties();
119 
120     public com.liferay.portal.model.ColorScheme getWapColorScheme()
121         throws com.liferay.portal.SystemException;
122 
123     public com.liferay.portal.model.Theme getWapTheme()
124         throws com.liferay.portal.SystemException;
125 
126     public boolean hasAncestor(long layoutId)
127         throws com.liferay.portal.PortalException,
128             com.liferay.portal.SystemException;
129 
130     public boolean hasScopeGroup()
131         throws com.liferay.portal.PortalException,
132             com.liferay.portal.SystemException;
133 
134     public boolean isChildSelected(boolean selectable,
135         com.liferay.portal.model.Layout layout);
136 
137     public boolean isFirstChild();
138 
139     public boolean isFirstParent();
140 
141     public boolean isInheritLookAndFeel();
142 
143     public boolean isInheritWapLookAndFeel();
144 
145     public boolean isPublicLayout();
146 
147     public boolean isRootLayout();
148 
149     public boolean isSelected(boolean selectable,
150         com.liferay.portal.model.Layout layout, long ancestorPlid);
151 
152     public boolean isTypeArticle();
153 
154     public boolean isTypeControlPanel();
155 
156     public boolean isTypeEmbedded();
157 
158     public boolean isTypeLinkToLayout();
159 
160     public boolean isTypePanel();
161 
162     public boolean isTypePortlet();
163 
164     public boolean isTypeURL();
165 
166     public void setName(java.lang.String name, java.util.Locale locale);
167 
168     public void setTitle(java.lang.String title, java.util.Locale locale);
169 
170     public void setTypeSettings(java.lang.String typeSettings);
171 
172     public void setTypeSettingsProperties(
173         com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties);
174 }