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