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