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.service;
16  
17  import com.liferay.portal.PortalException;
18  import com.liferay.portal.SystemException;
19  import com.liferay.portal.kernel.annotation.Isolation;
20  import com.liferay.portal.kernel.annotation.Propagation;
21  import com.liferay.portal.kernel.annotation.Transactional;
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          throws com.liferay.portal.PortalException,
57              com.liferay.portal.SystemException;
58  
59      public com.liferay.portal.model.Layout addLayout(long groupId,
60          boolean privateLayout, long parentLayoutId, java.lang.String name,
61          java.lang.String title, java.lang.String description,
62          java.lang.String type, boolean hidden, java.lang.String friendlyURL)
63          throws com.liferay.portal.PortalException,
64              com.liferay.portal.SystemException;
65  
66      public void deleteLayout(long plid)
67          throws com.liferay.portal.PortalException,
68              com.liferay.portal.SystemException;
69  
70      public void deleteLayout(long groupId, boolean privateLayout, long layoutId)
71          throws com.liferay.portal.PortalException,
72              com.liferay.portal.SystemException;
73  
74      public byte[] exportLayouts(long groupId, boolean privateLayout,
75          long[] layoutIds,
76          java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
77          java.util.Date startDate, java.util.Date endDate)
78          throws com.liferay.portal.PortalException,
79              com.liferay.portal.SystemException;
80  
81      public byte[] exportLayouts(long groupId, boolean privateLayout,
82          java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
83          java.util.Date startDate, java.util.Date endDate)
84          throws com.liferay.portal.PortalException,
85              com.liferay.portal.SystemException;
86  
87      public java.io.File exportLayoutsAsFile(long groupId,
88          boolean privateLayout, long[] layoutIds,
89          java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
90          java.util.Date startDate, java.util.Date endDate)
91          throws com.liferay.portal.PortalException,
92              com.liferay.portal.SystemException;
93  
94      public byte[] exportPortletInfo(long plid, long groupId,
95          java.lang.String portletId,
96          java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
97          java.util.Date startDate, java.util.Date endDate)
98          throws com.liferay.portal.PortalException,
99              com.liferay.portal.SystemException;
100 
101     public java.io.File exportPortletInfoAsFile(long plid, long groupId,
102         java.lang.String portletId,
103         java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
104         java.util.Date startDate, java.util.Date endDate)
105         throws com.liferay.portal.PortalException,
106             com.liferay.portal.SystemException;
107 
108     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
109     public java.lang.String getLayoutName(long groupId, boolean privateLayout,
110         long layoutId, java.lang.String languageId)
111         throws com.liferay.portal.PortalException,
112             com.liferay.portal.SystemException;
113 
114     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
115     public com.liferay.portal.model.LayoutReference[] getLayoutReferences(
116         long companyId, java.lang.String portletId,
117         java.lang.String preferencesKey, java.lang.String preferencesValue)
118         throws com.liferay.portal.SystemException;
119 
120     public void importLayouts(long groupId, boolean privateLayout,
121         java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
122         byte[] bytes)
123         throws com.liferay.portal.PortalException,
124             com.liferay.portal.SystemException;
125 
126     public void importLayouts(long groupId, boolean privateLayout,
127         java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
128         java.io.File file)
129         throws com.liferay.portal.PortalException,
130             com.liferay.portal.SystemException;
131 
132     public void importLayouts(long groupId, boolean privateLayout,
133         java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
134         java.io.InputStream is)
135         throws com.liferay.portal.PortalException,
136             com.liferay.portal.SystemException;
137 
138     public void importPortletInfo(long plid, long groupId,
139         java.lang.String portletId,
140         java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
141         java.io.File file)
142         throws com.liferay.portal.PortalException,
143             com.liferay.portal.SystemException;
144 
145     public void importPortletInfo(long plid, long groupId,
146         java.lang.String portletId,
147         java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
148         java.io.InputStream is)
149         throws com.liferay.portal.PortalException,
150             com.liferay.portal.SystemException;
151 
152     public void schedulePublishToLive(long sourceGroupId, long targetGroupId,
153         boolean privateLayout,
154         java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap,
155         java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
156         java.lang.String scope, java.util.Date startDate,
157         java.util.Date endDate, java.lang.String groupName,
158         java.lang.String cronText, java.util.Date schedulerStartDate,
159         java.util.Date schedulerEndDate, java.lang.String description)
160         throws com.liferay.portal.PortalException,
161             com.liferay.portal.SystemException;
162 
163     public void schedulePublishToRemote(long sourceGroupId,
164         boolean privateLayout,
165         java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap,
166         java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
167         java.lang.String remoteAddress, int remotePort,
168         boolean secureConnection, long remoteGroupId,
169         boolean remotePrivateLayout, java.util.Date startDate,
170         java.util.Date endDate, java.lang.String groupName,
171         java.lang.String cronText, java.util.Date schedulerStartDate,
172         java.util.Date schedulerEndDate, java.lang.String description)
173         throws com.liferay.portal.PortalException,
174             com.liferay.portal.SystemException;
175 
176     public void setLayouts(long groupId, boolean privateLayout,
177         long parentLayoutId, long[] layoutIds)
178         throws com.liferay.portal.PortalException,
179             com.liferay.portal.SystemException;
180 
181     public void unschedulePublishToLive(long groupId, java.lang.String jobName,
182         java.lang.String groupName)
183         throws com.liferay.portal.PortalException,
184             com.liferay.portal.SystemException;
185 
186     public void unschedulePublishToRemote(long groupId,
187         java.lang.String jobName, java.lang.String groupName)
188         throws com.liferay.portal.PortalException,
189             com.liferay.portal.SystemException;
190 
191     public com.liferay.portal.model.Layout updateLayout(long groupId,
192         boolean privateLayout, long layoutId, long parentLayoutId,
193         java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
194         java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
195         java.lang.String description, java.lang.String type, boolean hidden,
196         java.lang.String friendlyURL)
197         throws com.liferay.portal.PortalException,
198             com.liferay.portal.SystemException;
199 
200     public com.liferay.portal.model.Layout updateLayout(long groupId,
201         boolean privateLayout, long layoutId, long parentLayoutId,
202         java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
203         java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
204         java.lang.String description, java.lang.String type, boolean hidden,
205         java.lang.String friendlyURL, java.lang.Boolean iconImage,
206         byte[] iconBytes)
207         throws com.liferay.portal.PortalException,
208             com.liferay.portal.SystemException;
209 
210     public com.liferay.portal.model.Layout updateLayout(long groupId,
211         boolean privateLayout, long layoutId, java.lang.String typeSettings)
212         throws com.liferay.portal.PortalException,
213             com.liferay.portal.SystemException;
214 
215     public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
216         boolean privateLayout, long layoutId, java.lang.String themeId,
217         java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
218         throws com.liferay.portal.PortalException,
219             com.liferay.portal.SystemException;
220 
221     public com.liferay.portal.model.Layout updateName(long groupId,
222         boolean privateLayout, long layoutId, java.lang.String name,
223         java.lang.String languageId)
224         throws com.liferay.portal.PortalException,
225             com.liferay.portal.SystemException;
226 
227     public com.liferay.portal.model.Layout updateName(long plid,
228         java.lang.String name, java.lang.String languageId)
229         throws com.liferay.portal.PortalException,
230             com.liferay.portal.SystemException;
231 
232     public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
233         boolean privateLayout, long layoutId, long parentLayoutId)
234         throws com.liferay.portal.PortalException,
235             com.liferay.portal.SystemException;
236 
237     public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
238         long parentPlid)
239         throws com.liferay.portal.PortalException,
240             com.liferay.portal.SystemException;
241 
242     public com.liferay.portal.model.Layout updatePriority(long groupId,
243         boolean privateLayout, long layoutId, int priority)
244         throws com.liferay.portal.PortalException,
245             com.liferay.portal.SystemException;
246 
247     public com.liferay.portal.model.Layout updatePriority(long plid,
248         int priority)
249         throws com.liferay.portal.PortalException,
250             com.liferay.portal.SystemException;
251 }