1   /**
2    * Copyright (c) 2000-2007 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   * <a href="LayoutLocalService.java.html"><b><i>View Source</i></b></a>
27   *
28   * <p>
29   * ServiceBuilder generated this class. Modifications in this class will be overwritten
30   * the next time is generated.
31   * </p>
32   *
33   * <p>
34   * This interface defines the service. The default implementation is <code>com.liferay.portal.service.impl.LayoutLocalServiceImpl</code>.
35   * Modify methods in that class and rerun ServiceBuilder to populate this class
36   * and all other generated classes.
37   * </p>
38   *
39   * <p>
40   * This is a local service. Methods of this service will not have security checks
41   * based on the propagated JAAS credentials because this service can only be accessed
42   * from within the same VM.
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 LayoutLocalService {
52      public com.liferay.portal.model.Layout addLayout(
53          com.liferay.portal.model.Layout model)
54          throws com.liferay.portal.SystemException;
55  
56      public java.util.List dynamicQuery(
57          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer)
58          throws com.liferay.portal.SystemException;
59  
60      public java.util.List dynamicQuery(
61          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer,
62          int begin, int end) throws com.liferay.portal.SystemException;
63  
64      public com.liferay.portal.model.Layout updateLayout(
65          com.liferay.portal.model.Layout model)
66          throws com.liferay.portal.SystemException;
67  
68      public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
69          boolean privateLayout, long parentLayoutId, java.lang.String name,
70          java.lang.String title, java.lang.String description,
71          java.lang.String type, boolean hidden, java.lang.String friendlyURL)
72          throws com.liferay.portal.SystemException, 
73              com.liferay.portal.PortalException;
74  
75      public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
76          boolean privateLayout, long parentLayoutId, java.lang.String name,
77          java.lang.String title, java.lang.String description,
78          java.lang.String type, boolean hidden, java.lang.String friendlyURL,
79          long dlFolderId)
80          throws com.liferay.portal.SystemException, 
81              com.liferay.portal.PortalException;
82  
83      public void deleteLayout(long plid)
84          throws com.liferay.portal.SystemException, 
85              com.liferay.portal.PortalException;
86  
87      public void deleteLayout(long groupId, boolean privateLayout, long layoutId)
88          throws com.liferay.portal.SystemException, 
89              com.liferay.portal.PortalException;
90  
91      public void deleteLayout(com.liferay.portal.model.Layout layout,
92          boolean updateLayoutSet)
93          throws com.liferay.portal.SystemException, 
94              com.liferay.portal.PortalException;
95  
96      public void deleteLayouts(long groupId, boolean privateLayout)
97          throws com.liferay.portal.SystemException, 
98              com.liferay.portal.PortalException;
99  
100     public byte[] exportLayouts(long groupId, boolean privateLayout,
101         java.util.Map parameterMap)
102         throws com.liferay.portal.SystemException, 
103             com.liferay.portal.PortalException;
104 
105     public long getDefaultPlid(long groupId, boolean privateLayout)
106         throws com.liferay.portal.SystemException;
107 
108     public com.liferay.portal.model.Layout getDLFolderLayout(long dlFolderId)
109         throws com.liferay.portal.SystemException, 
110             com.liferay.portal.PortalException;
111 
112     public com.liferay.portal.model.Layout getFriendlyURLLayout(long groupId,
113         boolean privateLayout, java.lang.String friendlyURL)
114         throws com.liferay.portal.SystemException, 
115             com.liferay.portal.PortalException;
116 
117     public com.liferay.portal.model.Layout getLayout(long plid)
118         throws com.liferay.portal.SystemException, 
119             com.liferay.portal.PortalException;
120 
121     public com.liferay.portal.model.Layout getLayout(long groupId,
122         boolean privateLayout, long layoutId)
123         throws com.liferay.portal.SystemException, 
124             com.liferay.portal.PortalException;
125 
126     public java.util.List getLayouts(long groupId, boolean privateLayout)
127         throws com.liferay.portal.SystemException;
128 
129     public java.util.List getLayouts(long groupId, boolean privateLayout,
130         long parentLayoutId) throws com.liferay.portal.SystemException;
131 
132     public java.util.List getLayouts(long groupId, boolean privateLayout,
133         long parentLayoutId, int begin, int end)
134         throws com.liferay.portal.SystemException;
135 
136     public com.liferay.portal.model.LayoutReference[] getLayouts(
137         long companyId, java.lang.String portletId, java.lang.String prefsKey,
138         java.lang.String prefsValue) throws com.liferay.portal.SystemException;
139 
140     public void importLayouts(long userId, long groupId, boolean privateLayout,
141         java.util.Map parameterMap, java.io.File file)
142         throws com.liferay.portal.SystemException, 
143             com.liferay.portal.PortalException;
144 
145     public void importLayouts(long userId, long groupId, boolean privateLayout,
146         java.util.Map parameterMap, java.io.InputStream is)
147         throws com.liferay.portal.SystemException, 
148             com.liferay.portal.PortalException;
149 
150     public void setLayouts(long groupId, boolean privateLayout,
151         long parentLayoutId, long[] layoutIds)
152         throws com.liferay.portal.SystemException, 
153             com.liferay.portal.PortalException;
154 
155     public com.liferay.portal.model.Layout updateLayout(long groupId,
156         boolean privateLayout, long layoutId, long parentLayoutId,
157         java.lang.String name, java.lang.String title,
158         java.lang.String languageId, java.lang.String description,
159         java.lang.String type, boolean hidden, java.lang.String friendlyURL)
160         throws com.liferay.portal.SystemException, 
161             com.liferay.portal.PortalException;
162 
163     public com.liferay.portal.model.Layout updateLayout(long groupId,
164         boolean privateLayout, long layoutId, long parentLayoutId,
165         java.lang.String name, java.lang.String title,
166         java.lang.String languageId, java.lang.String description,
167         java.lang.String type, boolean hidden, java.lang.String friendlyURL,
168         java.lang.Boolean iconImage, byte[] iconBytes)
169         throws com.liferay.portal.SystemException, 
170             com.liferay.portal.PortalException;
171 
172     public com.liferay.portal.model.Layout updateLayout(long groupId,
173         boolean privateLayout, long layoutId, java.lang.String typeSettings)
174         throws com.liferay.portal.SystemException, 
175             com.liferay.portal.PortalException;
176 
177     public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
178         boolean privateLayout, long layoutId, java.lang.String themeId,
179         java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
180         throws com.liferay.portal.SystemException, 
181             com.liferay.portal.PortalException;
182 
183     public com.liferay.portal.model.Layout updateName(long plid,
184         java.lang.String name, java.lang.String languageId)
185         throws com.liferay.portal.SystemException, 
186             com.liferay.portal.PortalException;
187 
188     public com.liferay.portal.model.Layout updateName(long groupId,
189         boolean privateLayout, long layoutId, java.lang.String name,
190         java.lang.String languageId)
191         throws com.liferay.portal.SystemException, 
192             com.liferay.portal.PortalException;
193 
194     public com.liferay.portal.model.Layout updateName(
195         com.liferay.portal.model.Layout layout, java.lang.String name,
196         java.lang.String languageId)
197         throws com.liferay.portal.SystemException, 
198             com.liferay.portal.PortalException;
199 
200     public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
201         long parentPlid)
202         throws com.liferay.portal.SystemException, 
203             com.liferay.portal.PortalException;
204 
205     public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
206         boolean privateLayout, long layoutId, long parentLayoutId)
207         throws com.liferay.portal.SystemException, 
208             com.liferay.portal.PortalException;
209 
210     public com.liferay.portal.model.Layout updatePriority(long plid,
211         int priority)
212         throws com.liferay.portal.SystemException, 
213             com.liferay.portal.PortalException;
214 
215     public com.liferay.portal.model.Layout updatePriority(long groupId,
216         boolean privateLayout, long layoutId, int priority)
217         throws com.liferay.portal.SystemException, 
218             com.liferay.portal.PortalException;
219 
220     public com.liferay.portal.model.Layout updatePriority(
221         com.liferay.portal.model.Layout layout, int priority)
222         throws com.liferay.portal.SystemException, 
223             com.liferay.portal.PortalException;
224 }