1   /**
2    * Copyright (c) 2000-2009 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   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17   * SOFTWARE.
18   */
19  
20  package com.liferay.portal.service;
21  
22  import com.liferay.portal.PortalException;
23  import com.liferay.portal.SystemException;
24  import com.liferay.portal.kernel.annotation.Isolation;
25  import com.liferay.portal.kernel.annotation.Propagation;
26  import com.liferay.portal.kernel.annotation.Transactional;
27  
28  /**
29   * <a href="LayoutService.java.html"><b><i>View Source</i></b></a>
30   *
31   * <p>
32   * ServiceBuilder generated this class. Modifications in this class will be
33   * overwritten the next time is generated.
34   * </p>
35   *
36   * <p>
37   * This interface defines the service. The default implementation is
38   * <code>com.liferay.portal.service.impl.LayoutServiceImpl</code>.
39   * Modify methods in that class and rerun ServiceBuilder to populate this class
40   * and all other generated classes.
41   * </p>
42   *
43   * <p>
44   * 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.
45   * </p>
46   *
47   * @author Brian Wing Shun Chan
48   *
49   * @see com.liferay.portal.service.LayoutServiceUtil
50   *
51   */
52  @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
53      PortalException.class, SystemException.class})
54  public interface LayoutService {
55      public com.liferay.portal.model.Layout addLayout(long groupId,
56          boolean privateLayout, long parentLayoutId, java.lang.String name,
57          java.lang.String title, java.lang.String description,
58          java.lang.String type, boolean hidden, java.lang.String friendlyURL)
59          throws com.liferay.portal.PortalException,
60              com.liferay.portal.SystemException;
61  
62      public com.liferay.portal.model.Layout addLayout(long groupId,
63          boolean privateLayout, long parentLayoutId,
64          java.util.Map<java.util.Locale, String> localeNamesMap,
65          java.util.Map<java.util.Locale, String> localeTitlesMap,
66          java.lang.String description, java.lang.String type, boolean hidden,
67          java.lang.String friendlyURL)
68          throws com.liferay.portal.PortalException,
69              com.liferay.portal.SystemException;
70  
71      public void deleteLayout(long plid)
72          throws com.liferay.portal.PortalException,
73              com.liferay.portal.SystemException;
74  
75      public void deleteLayout(long groupId, boolean privateLayout, long layoutId)
76          throws com.liferay.portal.PortalException,
77              com.liferay.portal.SystemException;
78  
79      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
80      public java.lang.String getLayoutName(long groupId, boolean privateLayout,
81          long layoutId, java.lang.String languageId)
82          throws com.liferay.portal.PortalException,
83              com.liferay.portal.SystemException;
84  
85      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
86      public com.liferay.portal.model.LayoutReference[] getLayoutReferences(
87          long companyId, java.lang.String portletId,
88          java.lang.String preferencesKey, java.lang.String preferencesValue)
89          throws com.liferay.portal.SystemException;
90  
91      public byte[] exportLayouts(long groupId, boolean privateLayout,
92          java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
93          java.util.Date endDate)
94          throws com.liferay.portal.PortalException,
95              com.liferay.portal.SystemException;
96  
97      public byte[] exportLayouts(long groupId, boolean privateLayout,
98          long[] layoutIds, java.util.Map<String, String[]> parameterMap,
99          java.util.Date startDate, java.util.Date endDate)
100         throws com.liferay.portal.PortalException,
101             com.liferay.portal.SystemException;
102 
103     public com.liferay.portal.kernel.io.FileCacheOutputStream exportLayoutsAsStream(
104         long groupId, boolean privateLayout, long[] layoutIds,
105         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
106         java.util.Date endDate)
107         throws com.liferay.portal.PortalException,
108             com.liferay.portal.SystemException;
109 
110     public byte[] exportPortletInfo(long plid, long groupId,
111         java.lang.String portletId,
112         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
113         java.util.Date endDate)
114         throws com.liferay.portal.PortalException,
115             com.liferay.portal.SystemException;
116 
117     public com.liferay.portal.kernel.io.FileCacheOutputStream exportPortletInfoAsStream(
118         long plid, long groupId, java.lang.String portletId,
119         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
120         java.util.Date endDate)
121         throws com.liferay.portal.PortalException,
122             com.liferay.portal.SystemException;
123 
124     public void importLayouts(long groupId, boolean privateLayout,
125         java.util.Map<String, String[]> parameterMap, java.io.File file)
126         throws com.liferay.portal.PortalException,
127             com.liferay.portal.SystemException;
128 
129     public void importLayouts(long groupId, boolean privateLayout,
130         java.util.Map<String, String[]> parameterMap, byte[] bytes)
131         throws com.liferay.portal.PortalException,
132             com.liferay.portal.SystemException;
133 
134     public void importLayouts(long groupId, boolean privateLayout,
135         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
136         throws com.liferay.portal.PortalException,
137             com.liferay.portal.SystemException;
138 
139     public void importPortletInfo(long plid, long groupId,
140         java.lang.String portletId,
141         java.util.Map<String, String[]> parameterMap, 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<String, String[]> parameterMap, java.io.InputStream is)
148         throws 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 com.liferay.portal.PortalException,
247             com.liferay.portal.SystemException;
248 }