1   /**
2    * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3    *
4    * This library is free software; you can redistribute it and/or modify it under
5    * the terms of the GNU Lesser General Public License as published by the Free
6    * Software Foundation; either version 2.1 of the License, or (at your option)
7    * any later version.
8    *
9    * This library is distributed in the hope that it will be useful, but WITHOUT
10   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11   * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
12   * details.
13   */
14  
15  package com.liferay.portal.model;
16  
17  import com.liferay.portal.kernel.exception.PortalException;
18  import com.liferay.portal.kernel.exception.SystemException;
19  
20  import java.util.List;
21  
22  /**
23   * <a href="LayoutTypePortlet.java.html"><b><i>View Source</i></b></a>
24   *
25   * @author Brian Wing Shun Chan
26   */
27  public interface LayoutTypePortlet extends LayoutType {
28  
29      public void addModeAboutPortletId(String portletId);
30  
31      public void addModeConfigPortletId(String portletId);
32  
33      public void addModeEditDefaultsPortletId(String portletId);
34  
35      public void addModeEditGuestPortletId(String portletId);
36  
37      public void addModeEditPortletId(String portletId);
38  
39      public void addModeHelpPortletId(String portletId);
40  
41      public void addModePreviewPortletId(String portletId);
42  
43      public void addModePrintPortletId(String portletId);
44  
45      public String addPortletId(long userId, String portletId)
46          throws PortalException, SystemException;
47  
48      public String addPortletId(
49              long userId, String portletId, boolean checkPermission)
50          throws PortalException, SystemException;
51  
52      public String addPortletId(
53              long userId, String portletId, String columnId, int columnPos)
54          throws PortalException, SystemException;
55  
56      public String addPortletId(
57              long userId, String portletId, String columnId, int columnPos,
58              boolean checkPermission)
59          throws PortalException, SystemException;
60  
61      public void addPortletIds(
62              long userId, String[] portletIds, boolean checkPermission)
63          throws PortalException, SystemException;
64  
65      public void addPortletIds(
66              long userId, String[] portletIds, String columnId,
67              boolean checkPermission)
68          throws PortalException, SystemException;
69  
70      public void addStateMaxPortletId(String portletId);
71  
72      public void addStateMinPortletId(String portletId);
73  
74      public List<Portlet> addStaticPortlets(
75              List<Portlet> portlets, List<Portlet> startPortlets,
76              List<Portlet> endPortlets)
77          throws SystemException;
78  
79      public List<Portlet> getAllPortlets()
80          throws PortalException, SystemException;
81  
82      public List<Portlet> getAllPortlets(String columnId)
83          throws PortalException, SystemException;
84  
85      public LayoutTemplate getLayoutTemplate();
86  
87      public String getLayoutTemplateId();
88  
89      public String getModeAbout();
90  
91      public String getModeConfig();
92  
93      public String getModeEdit();
94  
95      public String getModeEditDefaults();
96  
97      public String getModeEditGuest();
98  
99      public String getModeHelp();
100 
101     public String getModePreview();
102 
103     public String getModePrint();
104 
105     public int getNumOfColumns();
106 
107     public List<String> getPortletIds();
108 
109     public List<Portlet> getPortlets() throws SystemException;
110 
111     public String getStateMax();
112 
113     public String getStateMaxPortletId();
114 
115     public String getStateMin();
116 
117     public boolean hasModeAboutPortletId(String portletId);
118 
119     public boolean hasModeConfigPortletId(String portletId);
120 
121     public boolean hasModeEditDefaultsPortletId(String portletId);
122 
123     public boolean hasModeEditGuestPortletId(String portletId);
124 
125     public boolean hasModeEditPortletId(String portletId);
126 
127     public boolean hasModeHelpPortletId(String portletId);
128 
129     public boolean hasModePreviewPortletId(String portletId);
130 
131     public boolean hasModePrintPortletId(String portletId);
132 
133     public boolean hasModeViewPortletId(String portletId);
134 
135     public boolean hasPortletId(String portletId)
136         throws PortalException, SystemException;
137 
138     public boolean hasStateMax();
139 
140     public boolean hasStateMaxPortletId(String portletId);
141 
142     public boolean hasStateMin();
143 
144     public boolean hasStateMinPortletId(String portletId);
145 
146     public boolean hasStateNormalPortletId(String portletId);
147 
148     public void movePortletId(
149             long userId, String portletId, String columnId, int columnPos)
150         throws PortalException, SystemException;
151 
152     public void removeModeAboutPortletId(String portletId);
153 
154     public void removeModeConfigPortletId(String portletId);
155 
156     public void removeModeEditDefaultsPortletId(String portletId);
157 
158     public void removeModeEditGuestPortletId(String portletId);
159 
160     public void removeModeEditPortletId(String portletId);
161 
162     public void removeModeHelpPortletId(String portletId);
163 
164     public void removeModePreviewPortletId(String portletId);
165 
166     public void removeModePrintPortletId(String portletId);
167 
168     public void removeModesPortletId(String portletId);
169 
170     public void removeNestedColumns(String portletId);
171 
172     public void removePortletId(long userId, String portletId);
173 
174     public void removePortletId(
175         long userId, String portletId, boolean modeAndState);
176 
177     public void removeStateMaxPortletId(String portletId);
178 
179     public void removeStateMinPortletId(String portletId);
180 
181     public void removeStatesPortletId(String portletId);
182 
183     public void reorganizePortlets(
184         List<String> newColumns, List<String> oldColumns);
185 
186     public void resetModes();
187 
188     public void resetStates();
189 
190     public void setLayoutTemplateId(long userId, String newLayoutTemplateId);
191 
192     public void setLayoutTemplateId(
193         long userId, String newLayoutTemplateId, boolean checkPermission);
194 
195     public void setModeAbout(String modeAbout);
196 
197     public void setModeConfig(String modeConfig);
198 
199     public void setModeEdit(String modeEdit);
200 
201     public void setModeEditDefaults(String modeEditDefaults);
202 
203     public void setModeEditGuest(String modeEditGuest);
204 
205     public void setModeHelp(String modeHelp);
206 
207     public void setModePreview(String modePreview);
208 
209     public void setModePrint(String modePrint);
210 
211     public void setPortletIds(String columnId, String portletIds);
212 
213     public void setStateMax(String stateMax);
214 
215     public void setStateMin(String stateMin);
216 
217 }