1   /**
2    * Copyright (c) 2000-2010 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   *
12   *
13   */
14  
15  package com.liferay.portal.model;
16  
17  import com.liferay.portal.PortalException;
18  import com.liferay.portal.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  
47      public String addPortletId(
48          long userId, String portletId, boolean checkPermission);
49  
50      public String addPortletId(
51          long userId, String portletId, String columnId, int columnPos);
52  
53      public String addPortletId(
54          long userId, String portletId, String columnId, int columnPos,
55          boolean checkPermission);
56  
57      public void addPortletIds(
58          long userId, String[] portletIds, boolean checkPermission);
59  
60      public void addPortletIds(
61          long userId, String[] portletIds, String columnId,
62          boolean checkPermission);
63  
64      public void addStateMaxPortletId(String portletId);
65  
66      public void addStateMinPortletId(String portletId);
67  
68      public List<Portlet> addStaticPortlets(
69              List<Portlet> portlets, List<Portlet> startPortlets,
70              List<Portlet> endPortlets)
71          throws SystemException;
72  
73      public List<Portlet> getAllPortlets() throws SystemException;
74  
75      public List<Portlet> getAllPortlets(String columnId) throws SystemException;
76  
77      public LayoutTemplate getLayoutTemplate();
78  
79      public String getLayoutTemplateId();
80  
81      public String getModeAbout();
82  
83      public String getModeConfig();
84  
85      public String getModeEdit();
86  
87      public String getModeEditDefaults();
88  
89      public String getModeEditGuest();
90  
91      public String getModeHelp();
92  
93      public String getModePreview();
94  
95      public String getModePrint();
96  
97      public int getNumOfColumns();
98  
99      public List<String> getPortletIds();
100 
101     public List<Portlet> getPortlets() throws SystemException;
102 
103     public String getStateMax();
104 
105     public String getStateMaxPortletId();
106 
107     public String getStateMin();
108 
109     public boolean hasDefaultScopePortletId(long groupId, String portletId)
110         throws PortalException, SystemException;
111 
112     public boolean hasModeAboutPortletId(String portletId);
113 
114     public boolean hasModeConfigPortletId(String portletId);
115 
116     public boolean hasModeEditDefaultsPortletId(String portletId);
117 
118     public boolean hasModeEditGuestPortletId(String portletId);
119 
120     public boolean hasModeEditPortletId(String portletId);
121 
122     public boolean hasModeHelpPortletId(String portletId);
123 
124     public boolean hasModePreviewPortletId(String portletId);
125 
126     public boolean hasModePrintPortletId(String portletId);
127 
128     public boolean hasModeViewPortletId(String portletId);
129 
130     public boolean hasPortletId(String portletId);
131 
132     public boolean hasStateMax();
133 
134     public boolean hasStateMaxPortletId(String portletId);
135 
136     public boolean hasStateMin();
137 
138     public boolean hasStateMinPortletId(String portletId);
139 
140     public boolean hasStateNormalPortletId(String portletId);
141 
142     public void movePortletId(
143         long userId, String portletId, String columnId, int columnPos);
144 
145     public void removeModeAboutPortletId(String portletId);
146 
147     public void removeModeConfigPortletId(String portletId);
148 
149     public void removeModeEditDefaultsPortletId(String portletId);
150 
151     public void removeModeEditGuestPortletId(String portletId);
152 
153     public void removeModeEditPortletId(String portletId);
154 
155     public void removeModeHelpPortletId(String portletId);
156 
157     public void removeModePreviewPortletId(String portletId);
158 
159     public void removeModePrintPortletId(String portletId);
160 
161     public void removeModesPortletId(String portletId);
162 
163     public void removeNestedColumns(String portletId);
164 
165     public void removePortletId(long userId, String portletId);
166 
167     public void removePortletId(
168         long userId, String portletId, boolean modeAndState);
169 
170     public void removeStateMaxPortletId(String portletId);
171 
172     public void removeStateMinPortletId(String portletId);
173 
174     public void removeStatesPortletId(String portletId);
175 
176     public void reorganizePortlets(
177         List<String> newColumns, List<String> oldColumns);
178 
179     public void resetModes();
180 
181     public void resetStates();
182 
183     public void setLayoutTemplateId(long userId, String newLayoutTemplateId);
184 
185     public void setLayoutTemplateId(
186         long userId, String newLayoutTemplateId, boolean checkPermission);
187 
188     public void setModeAbout(String modeAbout);
189 
190     public void setModeConfig(String modeConfig);
191 
192     public void setModeEdit(String modeEdit);
193 
194     public void setModeEditDefaults(String modeEditDefaults);
195 
196     public void setModeEditGuest(String modeEditGuest);
197 
198     public void setModeHelp(String modeHelp);
199 
200     public void setModePreview(String modePreview);
201 
202     public void setModePrint(String modePrint);
203 
204     public void setPortletIds(String columnId, String portletIds);
205 
206     public void setStateMax(String stateMax);
207 
208     public void setStateMin(String stateMin);
209 
210 }