1   /**
2    * Copyright (c) 2000-2007 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions 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   * <a href="Layout.java.html"><b><i>View Source</i></b></a>
27   *
28   * <p>
29   * ServiceBuilder generated this class. Modifications in this class will be overwritten
30   * the next time is generated.
31   * </p>
32   *
33   * <p>
34   * This interface is a model that represents the <code>Layout</code> table in the
35   * database.
36   * </p>
37   *
38   * <p>
39   * Customize <code>com.liferay.portal.service.model.impl.LayoutImpl</code> and rerun
40   * the ServiceBuilder to generate the new methods.
41   * </p>
42   *
43   * @author Brian Wing Shun Chan
44   *
45   * @see com.liferay.portal.service.model.LayoutModel
46   * @see com.liferay.portal.service.model.impl.LayoutImpl
47   * @see com.liferay.portal.service.model.impl.LayoutModelImpl
48   *
49   */
50  public interface Layout extends LayoutModel {
51      public com.liferay.portal.model.Group getGroup();
52  
53      public boolean isShared();
54  
55      public long getAncestorPlid();
56  
57      public long getAncestorLayoutId();
58  
59      public java.util.List getAncestors()
60          throws com.liferay.portal.SystemException, 
61              com.liferay.portal.PortalException;
62  
63      public boolean hasAncestor(long layoutId)
64          throws com.liferay.portal.SystemException, 
65              com.liferay.portal.PortalException;
66  
67      public boolean isFirstParent();
68  
69      public boolean isFirstChild();
70  
71      public boolean isRootLayout();
72  
73      public java.util.List getChildren()
74          throws com.liferay.portal.SystemException, 
75              com.liferay.portal.PortalException;
76  
77      public java.util.List getChildren(
78          com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker)
79          throws com.liferay.portal.SystemException, 
80              com.liferay.portal.PortalException;
81  
82      public java.lang.String getName(java.util.Locale locale);
83  
84      public java.lang.String getName(java.lang.String localeLanguageId);
85  
86      public void setName(java.lang.String name, java.util.Locale locale);
87  
88      public java.lang.String getTitle(java.util.Locale locale);
89  
90      public java.lang.String getTitle(java.lang.String localeLanguageId);
91  
92      public java.lang.String getHTMLTitle(java.util.Locale locale);
93  
94      public java.lang.String getHTMLTitle(java.lang.String localeLanguageId);
95  
96      public void setTitle(java.lang.String title, java.util.Locale locale);
97  
98      public com.liferay.portal.model.LayoutType getLayoutType();
99  
100     public java.lang.String getTypeSettings();
101 
102     public void setTypeSettings(java.lang.String typeSettings);
103 
104     public java.util.Properties getTypeSettingsProperties();
105 
106     public void setTypeSettingsProperties(
107         java.util.Properties typeSettingsProperties);
108 
109     public java.lang.String getDefaultFriendlyURL();
110 
111     public com.liferay.portal.model.LayoutSet getLayoutSet();
112 
113     public boolean isInheritLookAndFeel();
114 
115     public com.liferay.portal.model.Theme getTheme()
116         throws com.liferay.portal.SystemException, 
117             com.liferay.portal.PortalException;
118 
119     public com.liferay.portal.model.ColorScheme getColorScheme()
120         throws com.liferay.portal.SystemException, 
121             com.liferay.portal.PortalException;
122 
123     public boolean isInheritWapLookAndFeel();
124 
125     public com.liferay.portal.model.Theme getWapTheme()
126         throws com.liferay.portal.SystemException, 
127             com.liferay.portal.PortalException;
128 
129     public com.liferay.portal.model.ColorScheme getWapColorScheme()
130         throws com.liferay.portal.SystemException, 
131             com.liferay.portal.PortalException;
132 
133     public java.lang.String getCssText()
134         throws com.liferay.portal.SystemException, 
135             com.liferay.portal.PortalException;
136 
137     public java.lang.String getRegularURL(
138         javax.servlet.http.HttpServletRequest req)
139         throws com.liferay.portal.SystemException, 
140             com.liferay.portal.PortalException;
141 
142     public java.lang.String getResetMaxStateURL(
143         javax.servlet.http.HttpServletRequest req)
144         throws com.liferay.portal.SystemException, 
145             com.liferay.portal.PortalException;
146 
147     public java.lang.String getResetLayoutURL(
148         javax.servlet.http.HttpServletRequest req)
149         throws com.liferay.portal.SystemException, 
150             com.liferay.portal.PortalException;
151 
152     public java.lang.String getTarget();
153 
154     public boolean isSelected(boolean selectable,
155         com.liferay.portal.model.Layout layout, long ancestorPlid);
156 }