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