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.SystemException,
57              com.liferay.portal.PortalException;
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.SystemException,
66              com.liferay.portal.PortalException;
67  
68      public void deleteLayout(long plid)
69          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
70              com.liferay.portal.PortalException;
71  
72      public void deleteLayout(long groupId, boolean privateLayout, long layoutId)
73          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
74              com.liferay.portal.PortalException;
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.SystemException,
79              com.liferay.portal.PortalException;
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)
88          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
89              com.liferay.portal.PortalException;
90  
91      public byte[] exportLayouts(long groupId, boolean privateLayout,
92          long[] layoutIds, java.util.Map<String, String[]> parameterMap)
93          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
94              com.liferay.portal.PortalException;
95  
96      public byte[] exportPortletInfo(long plid, java.lang.String portletId,
97          java.util.Map<String, String[]> parameterMap)
98          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
99              com.liferay.portal.PortalException;
100 
101     public void importLayouts(long groupId, boolean privateLayout,
102         java.util.Map<String, String[]> parameterMap, java.io.File file)
103         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
104             com.liferay.portal.PortalException;
105 
106     public void importLayouts(long groupId, boolean privateLayout,
107         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
108         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
109             com.liferay.portal.PortalException;
110 
111     public void importPortletInfo(long plid, java.lang.String portletId,
112         java.util.Map<String, String[]> parameterMap, java.io.File file)
113         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
114             com.liferay.portal.PortalException;
115 
116     public void importPortletInfo(long plid, java.lang.String portletId,
117         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
118         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
119             com.liferay.portal.PortalException;
120 
121     public void setLayouts(long groupId, boolean privateLayout,
122         long parentLayoutId, long[] layoutIds)
123         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
124             com.liferay.portal.PortalException;
125 
126     public com.liferay.portal.model.Layout updateLayout(long groupId,
127         boolean privateLayout, long layoutId, long parentLayoutId,
128         java.util.Map<java.util.Locale, String> localeNamesMap,
129         java.util.Map<java.util.Locale, String> localeTitlesMap,
130         java.lang.String description, java.lang.String type, boolean hidden,
131         java.lang.String friendlyURL)
132         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
133             com.liferay.portal.PortalException;
134 
135     public com.liferay.portal.model.Layout updateLayout(long groupId,
136         boolean privateLayout, long layoutId, long parentLayoutId,
137         java.util.Map<java.util.Locale, String> localeNamesMap,
138         java.util.Map<java.util.Locale, String> localeTitlesMap,
139         java.lang.String description, java.lang.String type, boolean hidden,
140         java.lang.String friendlyURL, java.lang.Boolean iconImage,
141         byte[] iconBytes)
142         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
143             com.liferay.portal.PortalException;
144 
145     public com.liferay.portal.model.Layout updateLayout(long groupId,
146         boolean privateLayout, long layoutId, java.lang.String typeSettings)
147         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
148             com.liferay.portal.PortalException;
149 
150     public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
151         boolean privateLayout, long layoutId, java.lang.String themeId,
152         java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
153         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
154             com.liferay.portal.PortalException;
155 
156     public com.liferay.portal.model.Layout updateName(long plid,
157         java.lang.String name, java.lang.String languageId)
158         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
159             com.liferay.portal.PortalException;
160 
161     public com.liferay.portal.model.Layout updateName(long groupId,
162         boolean privateLayout, long layoutId, java.lang.String name,
163         java.lang.String languageId)
164         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
165             com.liferay.portal.PortalException;
166 
167     public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
168         long parentPlid)
169         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
170             com.liferay.portal.PortalException;
171 
172     public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
173         boolean privateLayout, long layoutId, long parentLayoutId)
174         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
175             com.liferay.portal.PortalException;
176 
177     public com.liferay.portal.model.Layout updatePriority(long plid,
178         int priority)
179         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
180             com.liferay.portal.PortalException;
181 
182     public com.liferay.portal.model.Layout updatePriority(long groupId,
183         boolean privateLayout, long layoutId, int priority)
184         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
185             com.liferay.portal.PortalException;
186 }