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