1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights 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  public interface LayoutTypePortlet extends LayoutType {
35  
36      public void addModeAboutPortletId(String portletId);
37  
38      public void addModeConfigPortletId(String portletId);
39  
40      public void addModeEditDefaultsPortletId(String portletId);
41  
42      public void addModeEditGuestPortletId(String portletId);
43  
44      public void addModeEditPortletId(String portletId);
45  
46      public void addModeHelpPortletId(String portletId);
47  
48      public void addModePreviewPortletId(String portletId);
49  
50      public void addModePrintPortletId(String portletId);
51  
52      public String addPortletId(long userId, String portletId);
53  
54      public String addPortletId(
55          long userId, String portletId, boolean checkPermission);
56  
57      public String addPortletId(
58          long userId, String portletId, String columnId, int columnPos);
59  
60      public String addPortletId(
61          long userId, String portletId, String columnId, int columnPos,
62          boolean checkPermission);
63  
64      public void addPortletIds(
65          long userId, String[] portletIds, boolean checkPermission);
66  
67      public void addPortletIds(
68          long userId, String[] portletIds, String columnId,
69          boolean checkPermission);
70  
71      public void addStateMaxPortletId(String portletId);
72  
73      public void addStateMinPortletId(String portletId);
74  
75      public List<Portlet> addStaticPortlets(
76              List<Portlet> portlets, List<Portlet> startPortlets,
77              List<Portlet> endPortlets)
78          throws SystemException;
79  
80      public List<Portlet> getAllPortlets() throws SystemException;
81  
82      public List<Portlet> getAllPortlets(String columnId) throws SystemException;
83  
84      public LayoutTemplate getLayoutTemplate();
85  
86      public String getLayoutTemplateId();
87  
88      public String getModeAbout();
89  
90      public String getModeConfig();
91  
92      public String getModeEdit();
93  
94      public String getModeEditDefaults();
95  
96      public String getModeEditGuest();
97  
98      public String getModeHelp();
99  
100     public String getModePreview();
101 
102     public String getModePrint();
103 
104     public int getNumOfColumns();
105 
106     public List<String> getPortletIds();
107 
108     public List<Portlet> getPortlets() throws SystemException;
109 
110     public String getStateMax();
111 
112     public String getStateMaxPortletId();
113 
114     public String getStateMin();
115 
116     public boolean hasModeAboutPortletId(String portletId);
117 
118     public boolean hasModeConfigPortletId(String portletId);
119 
120     public boolean hasModeEditDefaultsPortletId(String portletId);
121 
122     public boolean hasModeEditGuestPortletId(String portletId);
123 
124     public boolean hasModeEditPortletId(String portletId);
125 
126     public boolean hasModeHelpPortletId(String portletId);
127 
128     public boolean hasModePreviewPortletId(String portletId);
129 
130     public boolean hasModePrintPortletId(String portletId);
131 
132     public boolean hasModeViewPortletId(String portletId);
133 
134     public boolean hasPortletId(String portletId);
135 
136     public boolean hasStateMax();
137 
138     public boolean hasStateMaxPortletId(String portletId);
139 
140     public boolean hasStateMin();
141 
142     public boolean hasStateMinPortletId(String portletId);
143 
144     public boolean hasStateNormalPortletId(String portletId);
145 
146     public void movePortletId(
147         long userId, String portletId, String columnId, int columnPos);
148 
149     public void removeModeAboutPortletId(String portletId);
150 
151     public void removeModeConfigPortletId(String portletId);
152 
153     public void removeModeEditDefaultsPortletId(String portletId);
154 
155     public void removeModeEditGuestPortletId(String portletId);
156 
157     public void removeModeEditPortletId(String portletId);
158 
159     public void removeModeHelpPortletId(String portletId);
160 
161     public void removeModePreviewPortletId(String portletId);
162 
163     public void removeModePrintPortletId(String portletId);
164 
165     public void removeModesPortletId(String portletId);
166 
167     public void removeNestedColumns(String portletId);
168 
169     public void removePortletId(long userId, String portletId);
170 
171     public void removePortletId(
172         long userId, String portletId, boolean modeAndState);
173 
174     public void removeStateMaxPortletId(String portletId);
175 
176     public void removeStateMinPortletId(String portletId);
177 
178     public void removeStatesPortletId(String portletId);
179 
180     public void reorganizePortlets(
181         List<String> newColumns, List<String> oldColumns);
182 
183     public void resetModes();
184 
185     public void resetStates();
186 
187     public void setLayoutTemplateId(long userId, String newLayoutTemplateId);
188 
189     public void setLayoutTemplateId(
190         long userId, String newLayoutTemplateId, boolean checkPermission);
191 
192     public void setModeAbout(String modeAbout);
193 
194     public void setModeConfig(String modeConfig);
195 
196     public void setModeEdit(String modeEdit);
197 
198     public void setModeEditDefaults(String modeEditDefaults);
199 
200     public void setModeEditGuest(String modeEditGuest);
201 
202     public void setModeHelp(String modeHelp);
203 
204     public void setModePreview(String modePreview);
205 
206     public void setModePrint(String modePrint);
207 
208     public void setPortletIds(String columnId, String portletIds);
209 
210     public void setStateMax(String stateMax);
211 
212     public void setStateMin(String stateMin);
213 
214 }