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