1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions 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.service;
24  
25  import com.liferay.portal.PortalException;
26  import com.liferay.portal.SystemException;
27  import com.liferay.portal.kernel.annotation.Isolation;
28  import com.liferay.portal.kernel.annotation.Propagation;
29  import com.liferay.portal.kernel.annotation.Transactional;
30  
31  /**
32   * <a href="LayoutService.java.html"><b><i>View Source</i></b></a>
33   *
34   * <p>
35   * ServiceBuilder generated this class. Modifications in this class will be
36   * overwritten the next time is generated.
37   * </p>
38   *
39   * <p>
40   * This interface defines the service. The default implementation is
41   * <code>com.liferay.portal.service.impl.LayoutServiceImpl</code>.
42   * Modify methods in that class and rerun ServiceBuilder to populate this class
43   * and all other generated classes.
44   * </p>
45   *
46   * <p>
47   * 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.
48   * </p>
49   *
50   * @author Brian Wing Shun Chan
51   *
52   * @see com.liferay.portal.service.LayoutServiceUtil
53   *
54   */
55  @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
56      PortalException.class, SystemException.class})
57  public interface LayoutService {
58      public com.liferay.portal.model.Layout addLayout(long groupId,
59          boolean privateLayout, long parentLayoutId, java.lang.String name,
60          java.lang.String title, java.lang.String description,
61          java.lang.String type, boolean hidden, java.lang.String friendlyURL)
62          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
63              com.liferay.portal.SystemException;
64  
65      public com.liferay.portal.model.Layout addLayout(long groupId,
66          boolean privateLayout, long parentLayoutId,
67          java.util.Map<java.util.Locale, String> localeNamesMap,
68          java.util.Map<java.util.Locale, String> localeTitlesMap,
69          java.lang.String description, java.lang.String type, boolean hidden,
70          java.lang.String friendlyURL)
71          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
72              com.liferay.portal.SystemException;
73  
74      public void deleteLayout(long plid)
75          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
76              com.liferay.portal.SystemException;
77  
78      public void deleteLayout(long groupId, boolean privateLayout, long layoutId)
79          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
80              com.liferay.portal.SystemException;
81  
82      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
83      public java.lang.String getLayoutName(long groupId, boolean privateLayout,
84          long layoutId, java.lang.String languageId)
85          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
86              com.liferay.portal.SystemException;
87  
88      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
89      public com.liferay.portal.model.LayoutReference[] getLayoutReferences(
90          long companyId, java.lang.String portletId, java.lang.String prefsKey,
91          java.lang.String prefsValue)
92          throws java.rmi.RemoteException, com.liferay.portal.SystemException;
93  
94      public byte[] exportLayouts(long groupId, boolean privateLayout,
95          java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
96          java.util.Date endDate)
97          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
98              com.liferay.portal.SystemException;
99  
100     public byte[] exportLayouts(long groupId, boolean privateLayout,
101         long[] layoutIds, java.util.Map<String, String[]> parameterMap,
102         java.util.Date startDate, java.util.Date endDate)
103         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
104             com.liferay.portal.SystemException;
105 
106     public com.liferay.portal.kernel.io.FileCacheOutputStream exportLayoutsAsStream(
107         long groupId, boolean privateLayout, long[] layoutIds,
108         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
109         java.util.Date endDate)
110         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
111             com.liferay.portal.SystemException;
112 
113     public byte[] exportPortletInfo(long plid, java.lang.String portletId,
114         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
115         java.util.Date endDate)
116         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
117             com.liferay.portal.SystemException;
118 
119     public com.liferay.portal.kernel.io.FileCacheOutputStream exportPortletInfoAsStream(
120         long plid, java.lang.String portletId,
121         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
122         java.util.Date endDate)
123         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
124             com.liferay.portal.SystemException;
125 
126     public void importLayouts(long groupId, boolean privateLayout,
127         java.util.Map<String, String[]> parameterMap, java.io.File file)
128         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
129             com.liferay.portal.SystemException;
130 
131     public void importLayouts(long groupId, boolean privateLayout,
132         java.util.Map<String, String[]> parameterMap, byte[] bytes)
133         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
134             com.liferay.portal.SystemException;
135 
136     public void importLayouts(long groupId, boolean privateLayout,
137         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
138         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
139             com.liferay.portal.SystemException;
140 
141     public void importPortletInfo(long plid, java.lang.String portletId,
142         java.util.Map<String, String[]> parameterMap, java.io.File file)
143         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
144             com.liferay.portal.SystemException;
145 
146     public void importPortletInfo(long plid, java.lang.String portletId,
147         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
148         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
149             com.liferay.portal.SystemException;
150 
151     public void schedulePublishToLive(long sourceGroupId, long targetGroupId,
152         boolean privateLayout, java.util.Map<Long, Boolean> layoutIdMap,
153         java.util.Map<String, String[]> parameterMap, java.lang.String scope,
154         java.util.Date startDate, java.util.Date endDate,
155         java.lang.String groupName, java.lang.String cronText,
156         java.util.Date schedulerStartDate, java.util.Date schedulerEndDate,
157         java.lang.String description)
158         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
159             com.liferay.portal.SystemException;
160 
161     public void schedulePublishToRemote(long sourceGroupId,
162         boolean privateLayout, java.util.Map<Long, Boolean> layoutIdMap,
163         java.util.Map<String, String[]> parameterMap,
164         java.lang.String remoteAddress, int remotePort,
165         boolean secureConnection, long remoteGroupId,
166         boolean remotePrivateLayout, java.util.Date startDate,
167         java.util.Date endDate, java.lang.String groupName,
168         java.lang.String cronText, java.util.Date schedulerStartDate,
169         java.util.Date schedulerEndDate, java.lang.String description)
170         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
171             com.liferay.portal.SystemException;
172 
173     public void setLayouts(long groupId, boolean privateLayout,
174         long parentLayoutId, long[] layoutIds)
175         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
176             com.liferay.portal.SystemException;
177 
178     public void unschedulePublishToLive(long groupId, java.lang.String jobName,
179         java.lang.String groupName)
180         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
181             com.liferay.portal.SystemException;
182 
183     public void unschedulePublishToRemote(long groupId,
184         java.lang.String jobName, java.lang.String groupName)
185         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
186             com.liferay.portal.SystemException;
187 
188     public com.liferay.portal.model.Layout updateLayout(long groupId,
189         boolean privateLayout, long layoutId, long parentLayoutId,
190         java.util.Map<java.util.Locale, String> localeNamesMap,
191         java.util.Map<java.util.Locale, String> localeTitlesMap,
192         java.lang.String description, java.lang.String type, boolean hidden,
193         java.lang.String friendlyURL)
194         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
195             com.liferay.portal.SystemException;
196 
197     public com.liferay.portal.model.Layout updateLayout(long groupId,
198         boolean privateLayout, long layoutId, long parentLayoutId,
199         java.util.Map<java.util.Locale, String> localeNamesMap,
200         java.util.Map<java.util.Locale, String> localeTitlesMap,
201         java.lang.String description, java.lang.String type, boolean hidden,
202         java.lang.String friendlyURL, java.lang.Boolean iconImage,
203         byte[] iconBytes)
204         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
205             com.liferay.portal.SystemException;
206 
207     public com.liferay.portal.model.Layout updateLayout(long groupId,
208         boolean privateLayout, long layoutId, java.lang.String typeSettings)
209         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
210             com.liferay.portal.SystemException;
211 
212     public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
213         boolean privateLayout, long layoutId, java.lang.String themeId,
214         java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
215         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
216             com.liferay.portal.SystemException;
217 
218     public com.liferay.portal.model.Layout updateName(long plid,
219         java.lang.String name, java.lang.String languageId)
220         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
221             com.liferay.portal.SystemException;
222 
223     public com.liferay.portal.model.Layout updateName(long groupId,
224         boolean privateLayout, long layoutId, java.lang.String name,
225         java.lang.String languageId)
226         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
227             com.liferay.portal.SystemException;
228 
229     public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
230         long parentPlid)
231         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
232             com.liferay.portal.SystemException;
233 
234     public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
235         boolean privateLayout, long layoutId, long parentLayoutId)
236         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
237             com.liferay.portal.SystemException;
238 
239     public com.liferay.portal.model.Layout updatePriority(long plid,
240         int priority)
241         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
242             com.liferay.portal.SystemException;
243 
244     public com.liferay.portal.model.Layout updatePriority(long groupId,
245         boolean privateLayout, long layoutId, int priority)
246         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
247             com.liferay.portal.SystemException;
248 }