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