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  import com.liferay.portal.SystemException;
26  
27  import java.util.List;
28  
29  /**
30   * <a href="LayoutTypePortlet.java.html"><b><i>View Source</i></b></a>
31   *
32   * @author Brian Wing Shun Chan
33   *
34   */
35  public interface LayoutTypePortlet extends LayoutType {
36  
37      public LayoutTemplate getLayoutTemplate();
38  
39      public String getLayoutTemplateId();
40  
41      public void setLayoutTemplateId(long userId, String newLayoutTemplateId);
42  
43      public void setLayoutTemplateId(
44          long userId, String newLayoutTemplateId, boolean checkPermission);
45  
46      public int getNumOfColumns();
47  
48      public List<Portlet> getAllPortlets() throws SystemException;
49  
50      public List<Portlet> getAllPortlets(String columnId) throws SystemException;
51  
52      public List<Portlet> addStaticPortlets(
53              List<Portlet> portlets, List<Portlet> startPortlets,
54              List<Portlet> endPortlets)
55          throws SystemException;
56  
57      public String addPortletId(long userId, String portletId);
58  
59      public String addPortletId(
60          long userId, String portletId, boolean checkPermission);
61  
62      public String addPortletId(
63          long userId, String portletId, String columnId, int columnPos);
64  
65      public String addPortletId(
66          long userId, String portletId, String columnId, int columnPos,
67          boolean checkPermission);
68  
69      public void addPortletIds(
70          long userId, String[] portletIds, boolean checkPermission);
71  
72      public void addPortletIds(
73          long userId, String[] portletIds, String columnId,
74          boolean checkPermission);
75  
76      public List<Portlet> getPortlets() throws SystemException;
77  
78      public List<String> getPortletIds();
79  
80      public boolean hasPortletId(String portletId);
81  
82      public void movePortletId(
83          long userId, String portletId, String columnId, int columnPos);
84  
85      public void removePortletId(long userId, String portletId);
86  
87      public void removePortletId(
88          long userId, String portletId, boolean modeAndState);
89  
90      public void setPortletIds(String columnId, String portletIds);
91  
92      public void reorganizePortlets(
93          List<String> newColumns, List<String> oldColumns);
94  
95      public String getStateMax();
96  
97      public void setStateMax(String stateMax);
98  
99      public boolean hasStateMax();
100 
101     public void addStateMaxPortletId(String portletId);
102 
103     public String getStateMaxPortletId();
104 
105     public boolean hasStateMaxPortletId(String portletId);
106 
107     public void removeStateMaxPortletId(String portletId);
108 
109     public String getStateMin();
110 
111     public void setStateMin(String stateMin);
112 
113     public boolean hasStateMin();
114 
115     public void addStateMinPortletId(String portletId);
116 
117     public boolean hasStateMinPortletId(String portletId);
118 
119     public void removeStateMinPortletId(String portletId);
120 
121     public boolean hasStateNormalPortletId(String portletId);
122 
123     public void resetStates();
124 
125     public void removeStatesPortletId(String portletId);
126 
127     public String getModeAbout();
128 
129     public void setModeAbout(String modeAbout);
130 
131     public void addModeAboutPortletId(String portletId);
132 
133     public boolean hasModeAboutPortletId(String portletId);
134 
135     public void removeModeAboutPortletId(String portletId);
136 
137     public String getModeConfig();
138 
139     public void setModeConfig(String modeConfig);
140 
141     public void addModeConfigPortletId(String portletId);
142 
143     public boolean hasModeConfigPortletId(String portletId);
144 
145     public void removeModeConfigPortletId(String portletId);
146 
147     public String getModeEdit();
148 
149     public void setModeEdit(String modeEdit);
150 
151     public void addModeEditPortletId(String portletId);
152 
153     public boolean hasModeEditPortletId(String portletId);
154 
155     public void removeModeEditPortletId(String portletId);
156 
157     public String getModeEditDefaults();
158 
159     public void setModeEditDefaults(String modeEditDefaults);
160 
161     public void addModeEditDefaultsPortletId(String portletId);
162 
163     public boolean hasModeEditDefaultsPortletId(String portletId);
164 
165     public void removeModeEditDefaultsPortletId(String portletId);
166 
167     public String getModeEditGuest();
168 
169     public void setModeEditGuest(String modeEditGuest);
170 
171     public void addModeEditGuestPortletId(String portletId);
172 
173     public boolean hasModeEditGuestPortletId(String portletId);
174 
175     public void removeModeEditGuestPortletId(String portletId);
176 
177     public String getModeHelp();
178 
179     public void setModeHelp(String modeHelp);
180 
181     public void addModeHelpPortletId(String portletId);
182 
183     public boolean hasModeHelpPortletId(String portletId);
184 
185     public void removeModeHelpPortletId(String portletId);
186 
187     public String getModePreview();
188 
189     public void setModePreview(String modePreview);
190 
191     public void addModePreviewPortletId(String portletId);
192 
193     public boolean hasModePreviewPortletId(String portletId);
194 
195     public void removeModePreviewPortletId(String portletId);
196 
197     public String getModePrint();
198 
199     public void setModePrint(String modePrint);
200 
201     public void addModePrintPortletId(String portletId);
202 
203     public boolean hasModePrintPortletId(String portletId);
204 
205     public void removeModePrintPortletId(String portletId);
206 
207     public boolean hasModeViewPortletId(String portletId);
208 
209     public void resetModes();
210 
211     public void removeModesPortletId(String portletId);
212 
213     public void removeNestedColumns(String portletId);
214 
215 }