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.service;
16  
17  import com.liferay.portal.kernel.annotation.Isolation;
18  import com.liferay.portal.kernel.annotation.Propagation;
19  import com.liferay.portal.kernel.annotation.Transactional;
20  import com.liferay.portal.kernel.exception.PortalException;
21  import com.liferay.portal.kernel.exception.SystemException;
22  
23  /**
24   * <a href="LayoutService.java.html"><b><i>View Source</i></b></a>
25   *
26   * <p>
27   * ServiceBuilder generated this class. Modifications in this class will be
28   * overwritten the next time is generated.
29   * </p>
30   *
31   * <p>
32   * This interface defines the service. The default implementation is
33   * {@link
34   * com.liferay.portal.service.impl.LayoutServiceImpl}}.
35   * Modify methods in that class and rerun ServiceBuilder to populate this class
36   * and all other generated classes.
37   * </p>
38   *
39   * <p>
40   * This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
41   * </p>
42   *
43   * @author    Brian Wing Shun Chan
44   * @see       LayoutServiceUtil
45   * @generated
46   */
47  @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
48      PortalException.class, SystemException.class})
49  public interface LayoutService {
50      public com.liferay.portal.model.Layout addLayout(long groupId,
51          boolean privateLayout, long parentLayoutId,
52          java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
53          java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
54          java.lang.String description, java.lang.String type, boolean hidden,
55          java.lang.String friendlyURL,
56          com.liferay.portal.service.ServiceContext serviceContext)
57          throws com.liferay.portal.kernel.exception.PortalException,
58              com.liferay.portal.kernel.exception.SystemException;
59  
60      public com.liferay.portal.model.Layout addLayout(long groupId,
61          boolean privateLayout, long parentLayoutId, java.lang.String name,
62          java.lang.String title, java.lang.String description,
63          java.lang.String type, boolean hidden, java.lang.String friendlyURL,
64          com.liferay.portal.service.ServiceContext serviceContext)
65          throws com.liferay.portal.kernel.exception.PortalException,
66              com.liferay.portal.kernel.exception.SystemException;
67  
68      public void deleteLayout(long plid)
69          throws com.liferay.portal.kernel.exception.PortalException,
70              com.liferay.portal.kernel.exception.SystemException;
71  
72      public void deleteLayout(long groupId, boolean privateLayout, long layoutId)
73          throws com.liferay.portal.kernel.exception.PortalException,
74              com.liferay.portal.kernel.exception.SystemException;
75  
76      public byte[] exportLayouts(long groupId, boolean privateLayout,
77          long[] layoutIds,
78          java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
79          java.util.Date startDate, java.util.Date endDate)
80          throws com.liferay.portal.kernel.exception.PortalException,
81              com.liferay.portal.kernel.exception.SystemException;
82  
83      public byte[] exportLayouts(long groupId, boolean privateLayout,
84          java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
85          java.util.Date startDate, java.util.Date endDate)
86          throws com.liferay.portal.kernel.exception.PortalException,
87              com.liferay.portal.kernel.exception.SystemException;
88  
89      public java.io.File exportLayoutsAsFile(long groupId,
90          boolean privateLayout, long[] layoutIds,
91          java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
92          java.util.Date startDate, java.util.Date endDate)
93          throws com.liferay.portal.kernel.exception.PortalException,
94              com.liferay.portal.kernel.exception.SystemException;
95  
96      public byte[] exportPortletInfo(long plid, long groupId,
97          java.lang.String portletId,
98          java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
99          java.util.Date startDate, java.util.Date endDate)
100         throws com.liferay.portal.kernel.exception.PortalException,
101             com.liferay.portal.kernel.exception.SystemException;
102 
103     public java.io.File exportPortletInfoAsFile(long plid, long groupId,
104         java.lang.String portletId,
105         java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
106         java.util.Date startDate, java.util.Date endDate)
107         throws com.liferay.portal.kernel.exception.PortalException,
108             com.liferay.portal.kernel.exception.SystemException;
109 
110     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
111     public java.lang.String getLayoutName(long groupId, boolean privateLayout,
112         long layoutId, java.lang.String languageId)
113         throws com.liferay.portal.kernel.exception.PortalException,
114             com.liferay.portal.kernel.exception.SystemException;
115 
116     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
117     public com.liferay.portal.model.LayoutReference[] getLayoutReferences(
118         long companyId, java.lang.String portletId,
119         java.lang.String preferencesKey, java.lang.String preferencesValue)
120         throws com.liferay.portal.kernel.exception.SystemException;
121 
122     public void importLayouts(long groupId, boolean privateLayout,
123         java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
124         byte[] bytes)
125         throws com.liferay.portal.kernel.exception.PortalException,
126             com.liferay.portal.kernel.exception.SystemException;
127 
128     public void importLayouts(long groupId, boolean privateLayout,
129         java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
130         java.io.File file)
131         throws com.liferay.portal.kernel.exception.PortalException,
132             com.liferay.portal.kernel.exception.SystemException;
133 
134     public void importLayouts(long groupId, boolean privateLayout,
135         java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
136         java.io.InputStream is)
137         throws com.liferay.portal.kernel.exception.PortalException,
138             com.liferay.portal.kernel.exception.SystemException;
139 
140     public void importPortletInfo(long plid, long groupId,
141         java.lang.String portletId,
142         java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
143         java.io.File file)
144         throws com.liferay.portal.kernel.exception.PortalException,
145             com.liferay.portal.kernel.exception.SystemException;
146 
147     public void importPortletInfo(long plid, long groupId,
148         java.lang.String portletId,
149         java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
150         java.io.InputStream is)
151         throws com.liferay.portal.kernel.exception.PortalException,
152             com.liferay.portal.kernel.exception.SystemException;
153 
154     public void schedulePublishToLive(long sourceGroupId, long targetGroupId,
155         boolean privateLayout,
156         java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap,
157         java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
158         java.lang.String scope, java.util.Date startDate,
159         java.util.Date endDate, java.lang.String groupName,
160         java.lang.String cronText, java.util.Date schedulerStartDate,
161         java.util.Date schedulerEndDate, java.lang.String description)
162         throws com.liferay.portal.kernel.exception.PortalException,
163             com.liferay.portal.kernel.exception.SystemException;
164 
165     public void schedulePublishToRemote(long sourceGroupId,
166         boolean privateLayout,
167         java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap,
168         java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
169         java.lang.String remoteAddress, int remotePort,
170         boolean secureConnection, long remoteGroupId,
171         boolean remotePrivateLayout, java.util.Date startDate,
172         java.util.Date endDate, java.lang.String groupName,
173         java.lang.String cronText, java.util.Date schedulerStartDate,
174         java.util.Date schedulerEndDate, java.lang.String description)
175         throws com.liferay.portal.kernel.exception.PortalException,
176             com.liferay.portal.kernel.exception.SystemException;
177 
178     public void setLayouts(long groupId, boolean privateLayout,
179         long parentLayoutId, long[] layoutIds)
180         throws com.liferay.portal.kernel.exception.PortalException,
181             com.liferay.portal.kernel.exception.SystemException;
182 
183     public void unschedulePublishToLive(long groupId, java.lang.String jobName,
184         java.lang.String groupName)
185         throws com.liferay.portal.kernel.exception.PortalException,
186             com.liferay.portal.kernel.exception.SystemException;
187 
188     public void unschedulePublishToRemote(long groupId,
189         java.lang.String jobName, java.lang.String groupName)
190         throws com.liferay.portal.kernel.exception.PortalException,
191             com.liferay.portal.kernel.exception.SystemException;
192 
193     public com.liferay.portal.model.Layout updateLayout(long groupId,
194         boolean privateLayout, long layoutId, long parentLayoutId,
195         java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
196         java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
197         java.lang.String description, java.lang.String type, boolean hidden,
198         java.lang.String friendlyURL, java.lang.Boolean iconImage,
199         byte[] iconBytes,
200         com.liferay.portal.service.ServiceContext serviceContext)
201         throws com.liferay.portal.kernel.exception.PortalException,
202             com.liferay.portal.kernel.exception.SystemException;
203 
204     public com.liferay.portal.model.Layout updateLayout(long groupId,
205         boolean privateLayout, long layoutId, long parentLayoutId,
206         java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
207         java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
208         java.lang.String description, java.lang.String type, boolean hidden,
209         java.lang.String friendlyURL,
210         com.liferay.portal.service.ServiceContext serviceContext)
211         throws com.liferay.portal.kernel.exception.PortalException,
212             com.liferay.portal.kernel.exception.SystemException;
213 
214     public com.liferay.portal.model.Layout updateLayout(long groupId,
215         boolean privateLayout, long layoutId, java.lang.String typeSettings)
216         throws com.liferay.portal.kernel.exception.PortalException,
217             com.liferay.portal.kernel.exception.SystemException;
218 
219     public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
220         boolean privateLayout, long layoutId, java.lang.String themeId,
221         java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
222         throws com.liferay.portal.kernel.exception.PortalException,
223             com.liferay.portal.kernel.exception.SystemException;
224 
225     public com.liferay.portal.model.Layout updateName(long groupId,
226         boolean privateLayout, long layoutId, java.lang.String name,
227         java.lang.String languageId)
228         throws com.liferay.portal.kernel.exception.PortalException,
229             com.liferay.portal.kernel.exception.SystemException;
230 
231     public com.liferay.portal.model.Layout updateName(long plid,
232         java.lang.String name, java.lang.String languageId)
233         throws com.liferay.portal.kernel.exception.PortalException,
234             com.liferay.portal.kernel.exception.SystemException;
235 
236     public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
237         boolean privateLayout, long layoutId, long parentLayoutId)
238         throws com.liferay.portal.kernel.exception.PortalException,
239             com.liferay.portal.kernel.exception.SystemException;
240 
241     public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
242         long parentPlid)
243         throws com.liferay.portal.kernel.exception.PortalException,
244             com.liferay.portal.kernel.exception.SystemException;
245 
246     public com.liferay.portal.model.Layout updatePriority(long groupId,
247         boolean privateLayout, long layoutId, int priority)
248         throws com.liferay.portal.kernel.exception.PortalException,
249             com.liferay.portal.kernel.exception.SystemException;
250 
251     public com.liferay.portal.model.Layout updatePriority(long plid,
252         int priority)
253         throws com.liferay.portal.kernel.exception.PortalException,
254             com.liferay.portal.kernel.exception.SystemException;
255 }