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