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