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