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