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  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(String portletId);
86  
87      public void removePortletId(String portletId, boolean modeAndState);
88  
89      public void setPortletIds(String columnId, String portletIds);
90  
91      public void reorganizePortlets(
92          List<String> newColumns, List<String> oldColumns);
93  
94      public String getStateMax();
95  
96      public void setStateMax(String stateMax);
97  
98      public boolean hasStateMax();
99  
100     public void addStateMaxPortletId(String portletId);
101 
102     public String getStateMaxPortletId();
103 
104     public boolean hasStateMaxPortletId(String portletId);
105 
106     public void removeStateMaxPortletId(String portletId);
107 
108     public String getStateMin();
109 
110     public void setStateMin(String stateMin);
111 
112     public boolean hasStateMin();
113 
114     public void addStateMinPortletId(String portletId);
115 
116     public boolean hasStateMinPortletId(String portletId);
117 
118     public void removeStateMinPortletId(String portletId);
119 
120     public boolean hasStateNormalPortletId(String portletId);
121 
122     public void resetStates();
123 
124     public void removeStatesPortletId(String portletId);
125 
126     public String getModeAbout();
127 
128     public void setModeAbout(String modeAbout);
129 
130     public void addModeAboutPortletId(String portletId);
131 
132     public boolean hasModeAboutPortletId(String portletId);
133 
134     public void removeModeAboutPortletId(String portletId);
135 
136     public String getModeConfig();
137 
138     public void setModeConfig(String modeConfig);
139 
140     public void addModeConfigPortletId(String portletId);
141 
142     public boolean hasModeConfigPortletId(String portletId);
143 
144     public void removeModeConfigPortletId(String portletId);
145 
146     public String getModeEdit();
147 
148     public void setModeEdit(String modeEdit);
149 
150     public void addModeEditPortletId(String portletId);
151 
152     public boolean hasModeEditPortletId(String portletId);
153 
154     public void removeModeEditPortletId(String portletId);
155 
156     public String getModeEditDefaults();
157 
158     public void setModeEditDefaults(String modeEditDefaults);
159 
160     public void addModeEditDefaultsPortletId(String portletId);
161 
162     public boolean hasModeEditDefaultsPortletId(String portletId);
163 
164     public void removeModeEditDefaultsPortletId(String portletId);
165 
166     public String getModeEditGuest();
167 
168     public void setModeEditGuest(String modeEditGuest);
169 
170     public void addModeEditGuestPortletId(String portletId);
171 
172     public boolean hasModeEditGuestPortletId(String portletId);
173 
174     public void removeModeEditGuestPortletId(String portletId);
175 
176     public String getModeHelp();
177 
178     public void setModeHelp(String modeHelp);
179 
180     public void addModeHelpPortletId(String portletId);
181 
182     public boolean hasModeHelpPortletId(String portletId);
183 
184     public void removeModeHelpPortletId(String portletId);
185 
186     public String getModePreview();
187 
188     public void setModePreview(String modePreview);
189 
190     public void addModePreviewPortletId(String portletId);
191 
192     public boolean hasModePreviewPortletId(String portletId);
193 
194     public void removeModePreviewPortletId(String portletId);
195 
196     public String getModePrint();
197 
198     public void setModePrint(String modePrint);
199 
200     public void addModePrintPortletId(String portletId);
201 
202     public boolean hasModePrintPortletId(String portletId);
203 
204     public void removeModePrintPortletId(String portletId);
205 
206     public boolean hasModeViewPortletId(String portletId);
207 
208     public void resetModes();
209 
210     public void removeModesPortletId(String portletId);
211 
212     public void removeNestedColumns(String portletId);
213 
214 }