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.service;
21  
22  import com.liferay.portal.PortalException;
23  import com.liferay.portal.SystemException;
24  import com.liferay.portal.kernel.annotation.Propagation;
25  import com.liferay.portal.kernel.annotation.Transactional;
26  
27  /**
28   * <a href="LayoutLocalService.java.html"><b><i>View Source</i></b></a>
29   *
30   * <p>
31   * ServiceBuilder generated this class. Modifications in this class will be
32   * overwritten the next time is generated.
33   * </p>
34   *
35   * <p>
36   * This interface defines the service. The default implementation is
37   * <code>com.liferay.portal.service.impl.LayoutLocalServiceImpl</code>.
38   * Modify methods in that class and rerun ServiceBuilder to populate this class
39   * and all other generated classes.
40   * </p>
41   *
42   * <p>
43   * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
44   * </p>
45   *
46   * @author Brian Wing Shun Chan
47   *
48   * @see com.liferay.portal.service.LayoutLocalServiceUtil
49   *
50   */
51  @Transactional(rollbackFor =  {
52      PortalException.class, SystemException.class})
53  public interface LayoutLocalService {
54      public com.liferay.portal.model.Layout addLayout(
55          com.liferay.portal.model.Layout layout)
56          throws com.liferay.portal.SystemException;
57  
58      public com.liferay.portal.model.Layout createLayout(long plid);
59  
60      public void deleteLayout(long plid)
61          throws com.liferay.portal.SystemException,
62              com.liferay.portal.PortalException;
63  
64      public void deleteLayout(com.liferay.portal.model.Layout layout)
65          throws com.liferay.portal.SystemException;
66  
67      public java.util.List<Object> dynamicQuery(
68          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
69          throws com.liferay.portal.SystemException;
70  
71      public java.util.List<Object> dynamicQuery(
72          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
73          int end) throws com.liferay.portal.SystemException;
74  
75      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
76      public com.liferay.portal.model.Layout getLayout(long plid)
77          throws com.liferay.portal.SystemException,
78              com.liferay.portal.PortalException;
79  
80      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
81      public java.util.List<com.liferay.portal.model.Layout> getLayouts(
82          int start, int end) throws com.liferay.portal.SystemException;
83  
84      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
85      public int getLayoutsCount() throws com.liferay.portal.SystemException;
86  
87      public com.liferay.portal.model.Layout updateLayout(
88          com.liferay.portal.model.Layout layout)
89          throws com.liferay.portal.SystemException;
90  
91      public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
92          boolean privateLayout, long parentLayoutId, java.lang.String name,
93          java.lang.String title, java.lang.String description,
94          java.lang.String type, boolean hidden, java.lang.String friendlyURL)
95          throws com.liferay.portal.PortalException,
96              com.liferay.portal.SystemException;
97  
98      public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
99          boolean privateLayout, long parentLayoutId,
100         java.util.Map<java.util.Locale, String> localeNamesMap,
101         java.util.Map<java.util.Locale, String> localeTitlesMap,
102         java.lang.String description, java.lang.String type, boolean hidden,
103         java.lang.String friendlyURL)
104         throws com.liferay.portal.PortalException,
105             com.liferay.portal.SystemException;
106 
107     public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
108         boolean privateLayout, long parentLayoutId, java.lang.String name,
109         java.lang.String title, java.lang.String description,
110         java.lang.String type, boolean hidden, java.lang.String friendlyURL,
111         long dlFolderId)
112         throws com.liferay.portal.PortalException,
113             com.liferay.portal.SystemException;
114 
115     public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
116         boolean privateLayout, long parentLayoutId,
117         java.util.Map<java.util.Locale, String> localeNamesMap,
118         java.util.Map<java.util.Locale, String> localeTitlesMap,
119         java.lang.String description, java.lang.String type, boolean hidden,
120         java.lang.String friendlyURL, long dlFolderId)
121         throws com.liferay.portal.PortalException,
122             com.liferay.portal.SystemException;
123 
124     public void deleteLayout(long groupId, boolean privateLayout, long layoutId)
125         throws com.liferay.portal.PortalException,
126             com.liferay.portal.SystemException;
127 
128     public void deleteLayout(com.liferay.portal.model.Layout layout,
129         boolean updateLayoutSet)
130         throws com.liferay.portal.PortalException,
131             com.liferay.portal.SystemException;
132 
133     public void deleteLayouts(long groupId, boolean privateLayout)
134         throws com.liferay.portal.PortalException,
135             com.liferay.portal.SystemException;
136 
137     public byte[] exportLayouts(long groupId, boolean privateLayout,
138         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
139         java.util.Date endDate)
140         throws com.liferay.portal.PortalException,
141             com.liferay.portal.SystemException;
142 
143     public byte[] exportLayouts(long groupId, boolean privateLayout,
144         long[] layoutIds, java.util.Map<String, String[]> parameterMap,
145         java.util.Date startDate, java.util.Date endDate)
146         throws com.liferay.portal.PortalException,
147             com.liferay.portal.SystemException;
148 
149     public com.liferay.portal.kernel.io.FileCacheOutputStream exportLayoutsAsStream(
150         long groupId, boolean privateLayout, long[] layoutIds,
151         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
152         java.util.Date endDate)
153         throws com.liferay.portal.PortalException,
154             com.liferay.portal.SystemException;
155 
156     public byte[] exportPortletInfo(long plid, java.lang.String portletId,
157         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
158         java.util.Date endDate)
159         throws com.liferay.portal.PortalException,
160             com.liferay.portal.SystemException;
161 
162     public com.liferay.portal.kernel.io.FileCacheOutputStream exportPortletInfoAsStream(
163         long plid, java.lang.String portletId,
164         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
165         java.util.Date endDate)
166         throws com.liferay.portal.PortalException,
167             com.liferay.portal.SystemException;
168 
169     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170     public long getDefaultPlid(long groupId)
171         throws com.liferay.portal.SystemException;
172 
173     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174     public long getDefaultPlid(long groupId, boolean privateLayout)
175         throws com.liferay.portal.SystemException;
176 
177     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
178     public long getDefaultPlid(long groupId, boolean privateLayout,
179         java.lang.String portletId) throws com.liferay.portal.SystemException;
180 
181     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
182     public com.liferay.portal.model.Layout getDLFolderLayout(long dlFolderId)
183         throws com.liferay.portal.PortalException,
184             com.liferay.portal.SystemException;
185 
186     public com.liferay.portal.model.Layout getFriendlyURLLayout(long groupId,
187         boolean privateLayout, java.lang.String friendlyURL)
188         throws com.liferay.portal.PortalException,
189             com.liferay.portal.SystemException;
190 
191     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
192     public com.liferay.portal.model.Layout getLayout(long groupId,
193         boolean privateLayout, long layoutId)
194         throws com.liferay.portal.PortalException,
195             com.liferay.portal.SystemException;
196 
197     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
198     public com.liferay.portal.model.Layout getLayoutByIconImageId(
199         long iconImageId)
200         throws com.liferay.portal.PortalException,
201             com.liferay.portal.SystemException;
202 
203     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
204     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
205         long groupId, boolean privateLayout)
206         throws com.liferay.portal.SystemException;
207 
208     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
209     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
210         long groupId, boolean privateLayout, long parentLayoutId)
211         throws com.liferay.portal.SystemException;
212 
213     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
214     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
215         long groupId, boolean privateLayout, java.lang.String type)
216         throws com.liferay.portal.SystemException;
217 
218     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
219     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
220         long groupId, boolean privateLayout, long parentLayoutId, int start,
221         int end) throws com.liferay.portal.SystemException;
222 
223     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
224     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
225         long groupId, boolean privateLayout, long[] layoutIds)
226         throws com.liferay.portal.PortalException,
227             com.liferay.portal.SystemException;
228 
229     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
230     public com.liferay.portal.model.LayoutReference[] getLayouts(
231         long companyId, java.lang.String portletId, java.lang.String prefsKey,
232         java.lang.String prefsValue) throws com.liferay.portal.SystemException;
233 
234     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
235     public long getNextLayoutId(long groupId, boolean privateLayout)
236         throws com.liferay.portal.SystemException;
237 
238     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
239     public java.util.List<com.liferay.portal.model.Layout> getNullFriendlyURLLayouts()
240         throws com.liferay.portal.SystemException;
241 
242     public void importLayouts(long userId, long groupId, boolean privateLayout,
243         java.util.Map<String, String[]> parameterMap, java.io.File file)
244         throws com.liferay.portal.PortalException,
245             com.liferay.portal.SystemException;
246 
247     public void importLayouts(long userId, long groupId, boolean privateLayout,
248         java.util.Map<String, String[]> parameterMap, byte[] bytes)
249         throws com.liferay.portal.PortalException,
250             com.liferay.portal.SystemException;
251 
252     public void importLayouts(long userId, long groupId, boolean privateLayout,
253         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
254         throws com.liferay.portal.PortalException,
255             com.liferay.portal.SystemException;
256 
257     public void importPortletInfo(long userId, long plid,
258         java.lang.String portletId,
259         java.util.Map<String, String[]> parameterMap, java.io.File file)
260         throws com.liferay.portal.PortalException,
261             com.liferay.portal.SystemException;
262 
263     public void importPortletInfo(long userId, long plid,
264         java.lang.String portletId,
265         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
266         throws com.liferay.portal.PortalException,
267             com.liferay.portal.SystemException;
268 
269     public void setLayouts(long groupId, boolean privateLayout,
270         long parentLayoutId, long[] layoutIds)
271         throws com.liferay.portal.PortalException,
272             com.liferay.portal.SystemException;
273 
274     public com.liferay.portal.model.Layout updateFriendlyURL(long plid,
275         java.lang.String friendlyURL)
276         throws com.liferay.portal.PortalException,
277             com.liferay.portal.SystemException;
278 
279     public com.liferay.portal.model.Layout updateLayout(long groupId,
280         boolean privateLayout, long layoutId, long parentLayoutId,
281         java.util.Map<java.util.Locale, String> localeNamesMap,
282         java.util.Map<java.util.Locale, String> localeTitlesMap,
283         java.lang.String description, java.lang.String type, boolean hidden,
284         java.lang.String friendlyURL)
285         throws com.liferay.portal.PortalException,
286             com.liferay.portal.SystemException;
287 
288     public com.liferay.portal.model.Layout updateLayout(long groupId,
289         boolean privateLayout, long layoutId, long parentLayoutId,
290         java.util.Map<java.util.Locale, String> localeNamesMap,
291         java.util.Map<java.util.Locale, String> localeTitlesMap,
292         java.lang.String description, java.lang.String type, boolean hidden,
293         java.lang.String friendlyURL, java.lang.Boolean iconImage,
294         byte[] iconBytes)
295         throws com.liferay.portal.PortalException,
296             com.liferay.portal.SystemException;
297 
298     public com.liferay.portal.model.Layout updateLayout(long groupId,
299         boolean privateLayout, long layoutId, java.lang.String typeSettings)
300         throws com.liferay.portal.PortalException,
301             com.liferay.portal.SystemException;
302 
303     public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
304         boolean privateLayout, long layoutId, java.lang.String themeId,
305         java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
306         throws com.liferay.portal.PortalException,
307             com.liferay.portal.SystemException;
308 
309     public com.liferay.portal.model.Layout updateName(long plid,
310         java.lang.String name, java.lang.String languageId)
311         throws com.liferay.portal.PortalException,
312             com.liferay.portal.SystemException;
313 
314     public com.liferay.portal.model.Layout updateName(long groupId,
315         boolean privateLayout, long layoutId, java.lang.String name,
316         java.lang.String languageId)
317         throws com.liferay.portal.PortalException,
318             com.liferay.portal.SystemException;
319 
320     public com.liferay.portal.model.Layout updateName(
321         com.liferay.portal.model.Layout layout, java.lang.String name,
322         java.lang.String languageId)
323         throws com.liferay.portal.PortalException,
324             com.liferay.portal.SystemException;
325 
326     public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
327         long parentPlid)
328         throws com.liferay.portal.PortalException,
329             com.liferay.portal.SystemException;
330 
331     public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
332         boolean privateLayout, long layoutId, long parentLayoutId)
333         throws com.liferay.portal.PortalException,
334             com.liferay.portal.SystemException;
335 
336     public com.liferay.portal.model.Layout updatePriority(long plid,
337         int priority)
338         throws com.liferay.portal.PortalException,
339             com.liferay.portal.SystemException;
340 
341     public com.liferay.portal.model.Layout updatePriority(long groupId,
342         boolean privateLayout, long layoutId, int priority)
343         throws com.liferay.portal.PortalException,
344             com.liferay.portal.SystemException;
345 
346     public com.liferay.portal.model.Layout updatePriority(
347         com.liferay.portal.model.Layout layout, int priority)
348         throws com.liferay.portal.SystemException;
349 }