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