1   /**
2    * Copyright (c) 2000-2008 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  /**
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 <code>Layout</code> table
36   * in the database.
37   * </p>
38   *
39   * <p>
40   * Customize <code>com.liferay.portal.service.model.impl.LayoutImpl</code>
41   * and rerun the ServiceBuilder to generate the new methods.
42   * </p>
43   *
44   * @author Brian Wing Shun Chan
45   *
46   * @see com.liferay.portal.service.model.LayoutModel
47   * @see com.liferay.portal.service.model.impl.LayoutImpl
48   * @see com.liferay.portal.service.model.impl.LayoutModelImpl
49   *
50   */
51  public interface Layout extends LayoutModel {
52      public com.liferay.portal.model.Group getGroup();
53  
54      public boolean isShared();
55  
56      public long getAncestorPlid();
57  
58      public long getAncestorLayoutId();
59  
60      public java.util.List<com.liferay.portal.model.Layout> getAncestors()
61          throws com.liferay.portal.SystemException,
62              com.liferay.portal.PortalException;
63  
64      public boolean hasAncestor(long layoutId)
65          throws com.liferay.portal.SystemException,
66              com.liferay.portal.PortalException;
67  
68      public boolean isFirstParent();
69  
70      public boolean isFirstChild();
71  
72      public boolean isRootLayout();
73  
74      public java.util.List<com.liferay.portal.model.Layout> getChildren()
75          throws com.liferay.portal.SystemException,
76              com.liferay.portal.PortalException;
77  
78      public java.util.List<com.liferay.portal.model.Layout> getAllChildren()
79          throws com.liferay.portal.SystemException,
80              com.liferay.portal.PortalException;
81  
82      public java.util.List<com.liferay.portal.model.Layout> getChildren(
83          com.liferay.portal.security.permission.PermissionChecker permissionChecker)
84          throws com.liferay.portal.SystemException,
85              com.liferay.portal.PortalException;
86  
87      public java.lang.String getName(java.util.Locale locale);
88  
89      public java.lang.String getName(java.lang.String localeLanguageId);
90  
91      public java.lang.String getName(java.util.Locale locale, boolean useDefault);
92  
93      public java.lang.String getName(java.lang.String localeLanguageId,
94          boolean useDefault);
95  
96      public void setName(java.lang.String name, java.util.Locale locale);
97  
98      public java.lang.String getTitle(java.util.Locale locale);
99  
100     public java.lang.String getTitle(java.lang.String localeLanguageId);
101 
102     public java.lang.String getTitle(java.util.Locale locale, boolean useDefault);
103 
104     public java.lang.String getTitle(java.lang.String localeLanguageId,
105         boolean useDefault);
106 
107     public java.lang.String getHTMLTitle(java.util.Locale locale);
108 
109     public java.lang.String getHTMLTitle(java.lang.String localeLanguageId);
110 
111     public void setTitle(java.lang.String title, java.util.Locale locale);
112 
113     public com.liferay.portal.model.LayoutType getLayoutType();
114 
115     public java.lang.String getTypeSettings();
116 
117     public void setTypeSettings(java.lang.String typeSettings);
118 
119     public java.util.Properties getTypeSettingsProperties();
120 
121     public void setTypeSettingsProperties(
122         java.util.Properties typeSettingsProperties);
123 
124     public com.liferay.portal.model.LayoutSet getLayoutSet();
125 
126     public boolean isInheritLookAndFeel();
127 
128     public com.liferay.portal.model.Theme getTheme()
129         throws com.liferay.portal.SystemException,
130             com.liferay.portal.PortalException;
131 
132     public com.liferay.portal.model.ColorScheme getColorScheme()
133         throws com.liferay.portal.SystemException,
134             com.liferay.portal.PortalException;
135 
136     public boolean isInheritWapLookAndFeel();
137 
138     public com.liferay.portal.model.Theme getWapTheme()
139         throws com.liferay.portal.SystemException,
140             com.liferay.portal.PortalException;
141 
142     public com.liferay.portal.model.ColorScheme getWapColorScheme()
143         throws com.liferay.portal.SystemException,
144             com.liferay.portal.PortalException;
145 
146     public java.lang.String getCssText()
147         throws com.liferay.portal.SystemException,
148             com.liferay.portal.PortalException;
149 
150     public java.lang.String getRegularURL(
151         javax.servlet.http.HttpServletRequest req)
152         throws com.liferay.portal.SystemException,
153             com.liferay.portal.PortalException;
154 
155     public java.lang.String getResetMaxStateURL(
156         javax.servlet.http.HttpServletRequest req)
157         throws com.liferay.portal.SystemException,
158             com.liferay.portal.PortalException;
159 
160     public java.lang.String getResetLayoutURL(
161         javax.servlet.http.HttpServletRequest req)
162         throws com.liferay.portal.SystemException,
163             com.liferay.portal.PortalException;
164 
165     public java.lang.String getTarget();
166 
167     public boolean isSelected(boolean selectable,
168         com.liferay.portal.model.Layout layout, long ancestorPlid);
169 }