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.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 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 com.liferay.portal.PortalException,
71              com.liferay.portal.SystemException;
72  
73      public void deleteLayout(long plid)
74          throws com.liferay.portal.PortalException,
75              com.liferay.portal.SystemException;
76  
77      public void deleteLayout(long groupId, boolean privateLayout, long layoutId)
78          throws 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 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,
90          java.lang.String preferencesKey, java.lang.String preferencesValue)
91          throws 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 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 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 com.liferay.portal.PortalException,
110             com.liferay.portal.SystemException;
111 
112     public byte[] exportPortletInfo(long plid, long groupId,
113         java.lang.String portletId,
114         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
115         java.util.Date endDate)
116         throws com.liferay.portal.PortalException,
117             com.liferay.portal.SystemException;
118 
119     public com.liferay.portal.kernel.io.FileCacheOutputStream exportPortletInfoAsStream(
120         long plid, long groupId, java.lang.String portletId,
121         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
122         java.util.Date endDate)
123         throws 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 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 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 com.liferay.portal.PortalException,
139             com.liferay.portal.SystemException;
140 
141     public void importPortletInfo(long plid, long groupId,
142         java.lang.String portletId,
143         java.util.Map<String, String[]> parameterMap, java.io.File file)
144         throws com.liferay.portal.PortalException,
145             com.liferay.portal.SystemException;
146 
147     public void importPortletInfo(long plid, long groupId,
148         java.lang.String portletId,
149         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
150         throws com.liferay.portal.PortalException,
151             com.liferay.portal.SystemException;
152 
153     public void schedulePublishToLive(long sourceGroupId, long targetGroupId,
154         boolean privateLayout, java.util.Map<Long, Boolean> layoutIdMap,
155         java.util.Map<String, String[]> parameterMap, java.lang.String scope,
156         java.util.Date startDate, java.util.Date endDate,
157         java.lang.String groupName, java.lang.String cronText,
158         java.util.Date schedulerStartDate, java.util.Date schedulerEndDate,
159         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, java.util.Map<Long, Boolean> layoutIdMap,
165         java.util.Map<String, String[]> parameterMap,
166         java.lang.String remoteAddress, int remotePort,
167         boolean secureConnection, long remoteGroupId,
168         boolean remotePrivateLayout, java.util.Date startDate,
169         java.util.Date endDate, java.lang.String groupName,
170         java.lang.String cronText, java.util.Date schedulerStartDate,
171         java.util.Date schedulerEndDate, java.lang.String description)
172         throws com.liferay.portal.PortalException,
173             com.liferay.portal.SystemException;
174 
175     public void setLayouts(long groupId, boolean privateLayout,
176         long parentLayoutId, long[] layoutIds)
177         throws com.liferay.portal.PortalException,
178             com.liferay.portal.SystemException;
179 
180     public void unschedulePublishToLive(long groupId, java.lang.String jobName,
181         java.lang.String groupName)
182         throws com.liferay.portal.PortalException,
183             com.liferay.portal.SystemException;
184 
185     public void unschedulePublishToRemote(long groupId,
186         java.lang.String jobName, java.lang.String groupName)
187         throws com.liferay.portal.PortalException,
188             com.liferay.portal.SystemException;
189 
190     public com.liferay.portal.model.Layout updateLayout(long groupId,
191         boolean privateLayout, long layoutId, long parentLayoutId,
192         java.util.Map<java.util.Locale, String> localeNamesMap,
193         java.util.Map<java.util.Locale, String> localeTitlesMap,
194         java.lang.String description, java.lang.String type, boolean hidden,
195         java.lang.String friendlyURL)
196         throws com.liferay.portal.PortalException,
197             com.liferay.portal.SystemException;
198 
199     public com.liferay.portal.model.Layout updateLayout(long groupId,
200         boolean privateLayout, long layoutId, long parentLayoutId,
201         java.util.Map<java.util.Locale, String> localeNamesMap,
202         java.util.Map<java.util.Locale, String> localeTitlesMap,
203         java.lang.String description, java.lang.String type, boolean hidden,
204         java.lang.String friendlyURL, java.lang.Boolean iconImage,
205         byte[] iconBytes)
206         throws com.liferay.portal.PortalException,
207             com.liferay.portal.SystemException;
208 
209     public com.liferay.portal.model.Layout updateLayout(long groupId,
210         boolean privateLayout, long layoutId, java.lang.String typeSettings)
211         throws com.liferay.portal.PortalException,
212             com.liferay.portal.SystemException;
213 
214     public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
215         boolean privateLayout, long layoutId, java.lang.String themeId,
216         java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
217         throws com.liferay.portal.PortalException,
218             com.liferay.portal.SystemException;
219 
220     public com.liferay.portal.model.Layout updateName(long plid,
221         java.lang.String name, java.lang.String languageId)
222         throws com.liferay.portal.PortalException,
223             com.liferay.portal.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.PortalException,
229             com.liferay.portal.SystemException;
230 
231     public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
232         long parentPlid)
233         throws com.liferay.portal.PortalException,
234             com.liferay.portal.SystemException;
235 
236     public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
237         boolean privateLayout, long layoutId, long parentLayoutId)
238         throws com.liferay.portal.PortalException,
239             com.liferay.portal.SystemException;
240 
241     public com.liferay.portal.model.Layout updatePriority(long plid,
242         int priority)
243         throws com.liferay.portal.PortalException,
244             com.liferay.portal.SystemException;
245 
246     public com.liferay.portal.model.Layout updatePriority(long groupId,
247         boolean privateLayout, long layoutId, int priority)
248         throws com.liferay.portal.PortalException,
249             com.liferay.portal.SystemException;
250 }