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 boolean isPublicLayout();
54  
55      public long getAncestorPlid();
56  
57      public long getAncestorLayoutId();
58  
59      public java.util.List<com.liferay.portal.model.Layout> getAncestors()
60          throws com.liferay.portal.PortalException,
61              com.liferay.portal.SystemException;
62  
63      public boolean hasAncestor(long layoutId)
64          throws com.liferay.portal.PortalException,
65              com.liferay.portal.SystemException;
66  
67      public boolean isFirstParent();
68  
69      public boolean isFirstChild();
70  
71      public boolean isRootLayout();
72  
73      public java.util.List<com.liferay.portal.model.Layout> getChildren()
74          throws com.liferay.portal.SystemException;
75  
76      public java.util.List<com.liferay.portal.model.Layout> getAllChildren()
77          throws com.liferay.portal.SystemException;
78  
79      public java.util.List<com.liferay.portal.model.Layout> getChildren(
80          com.liferay.portal.security.permission.PermissionChecker permissionChecker)
81          throws com.liferay.portal.PortalException,
82              com.liferay.portal.SystemException;
83  
84      public java.lang.String getName(java.util.Locale locale);
85  
86      public java.lang.String getName(java.lang.String localeLanguageId);
87  
88      public java.lang.String getName(java.util.Locale locale, boolean useDefault);
89  
90      public java.lang.String getName(java.lang.String localeLanguageId,
91          boolean useDefault);
92  
93      public void setName(java.lang.String name, java.util.Locale locale);
94  
95      public java.lang.String getTitle(java.util.Locale locale);
96  
97      public java.lang.String getTitle(java.lang.String localeLanguageId);
98  
99      public java.lang.String getTitle(java.util.Locale locale, boolean useDefault);
100 
101     public java.lang.String getTitle(java.lang.String localeLanguageId,
102         boolean useDefault);
103 
104     public java.lang.String getHTMLTitle(java.util.Locale locale);
105 
106     public java.lang.String getHTMLTitle(java.lang.String localeLanguageId);
107 
108     public void setTitle(java.lang.String title, java.util.Locale locale);
109 
110     public com.liferay.portal.model.LayoutType getLayoutType();
111 
112     public java.lang.String getTypeSettings();
113 
114     public void setTypeSettings(java.lang.String typeSettings);
115 
116     public com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties();
117 
118     public void setTypeSettingsProperties(
119         com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties);
120 
121     public com.liferay.portal.model.LayoutSet getLayoutSet();
122 
123     public boolean isInheritLookAndFeel();
124 
125     public com.liferay.portal.model.Theme getTheme();
126 
127     public com.liferay.portal.model.ColorScheme getColorScheme();
128 
129     public boolean isInheritWapLookAndFeel();
130 
131     public com.liferay.portal.model.Theme getWapTheme();
132 
133     public com.liferay.portal.model.ColorScheme getWapColorScheme();
134 
135     public java.lang.String getCssText();
136 
137     public java.lang.String getRegularURL(
138         javax.servlet.http.HttpServletRequest request)
139         throws com.liferay.portal.SystemException;
140 
141     public java.lang.String getResetMaxStateURL(
142         javax.servlet.http.HttpServletRequest request)
143         throws com.liferay.portal.SystemException;
144 
145     public java.lang.String getResetLayoutURL(
146         javax.servlet.http.HttpServletRequest request)
147         throws com.liferay.portal.SystemException;
148 
149     public java.lang.String getTarget();
150 
151     public boolean isChildSelected(boolean selectable,
152         com.liferay.portal.model.Layout layout);
153 
154     public boolean isSelected(boolean selectable,
155         com.liferay.portal.model.Layout layout, long ancestorPlid);
156 }