001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.jsonwebservice.JSONWebService;
020    import com.liferay.portal.kernel.transaction.Isolation;
021    import com.liferay.portal.kernel.transaction.Propagation;
022    import com.liferay.portal.kernel.transaction.Transactional;
023    
024    /**
025     * The interface for the layout remote service.
026     *
027     * <p>
028     * 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.
029     * </p>
030     *
031     * @author Brian Wing Shun Chan
032     * @see LayoutServiceUtil
033     * @see com.liferay.portal.service.base.LayoutServiceBaseImpl
034     * @see com.liferay.portal.service.impl.LayoutServiceImpl
035     * @generated
036     */
037    @JSONWebService
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface LayoutService {
041            /*
042             * NOTE FOR DEVELOPERS:
043             *
044             * Never modify or reference this interface directly. Always use {@link LayoutServiceUtil} to access the layout remote service. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
045             */
046            public com.liferay.portal.model.Layout addLayout(long groupId,
047                    boolean privateLayout, long parentLayoutId,
048                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
049                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
050                    java.lang.String description, java.lang.String type, boolean hidden,
051                    java.lang.String friendlyURL,
052                    com.liferay.portal.service.ServiceContext serviceContext)
053                    throws com.liferay.portal.kernel.exception.PortalException,
054                            com.liferay.portal.kernel.exception.SystemException;
055    
056            public com.liferay.portal.model.Layout addLayout(long groupId,
057                    boolean privateLayout, long parentLayoutId, java.lang.String name,
058                    java.lang.String title, java.lang.String description,
059                    java.lang.String type, boolean hidden, java.lang.String friendlyURL,
060                    com.liferay.portal.service.ServiceContext serviceContext)
061                    throws com.liferay.portal.kernel.exception.PortalException,
062                            com.liferay.portal.kernel.exception.SystemException;
063    
064            public void deleteLayout(long plid)
065                    throws com.liferay.portal.kernel.exception.PortalException,
066                            com.liferay.portal.kernel.exception.SystemException;
067    
068            public void deleteLayout(long groupId, boolean privateLayout, long layoutId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException;
071    
072            public byte[] exportLayouts(long groupId, boolean privateLayout,
073                    long[] layoutIds,
074                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
075                    java.util.Date startDate, java.util.Date endDate)
076                    throws com.liferay.portal.kernel.exception.PortalException,
077                            com.liferay.portal.kernel.exception.SystemException;
078    
079            public byte[] exportLayouts(long groupId, boolean privateLayout,
080                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
081                    java.util.Date startDate, java.util.Date endDate)
082                    throws com.liferay.portal.kernel.exception.PortalException,
083                            com.liferay.portal.kernel.exception.SystemException;
084    
085            public java.io.File exportLayoutsAsFile(long groupId,
086                    boolean privateLayout, long[] layoutIds,
087                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
088                    java.util.Date startDate, java.util.Date endDate)
089                    throws com.liferay.portal.kernel.exception.PortalException,
090                            com.liferay.portal.kernel.exception.SystemException;
091    
092            public byte[] exportPortletInfo(long plid, long groupId,
093                    java.lang.String portletId,
094                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
095                    java.util.Date startDate, java.util.Date endDate)
096                    throws com.liferay.portal.kernel.exception.PortalException,
097                            com.liferay.portal.kernel.exception.SystemException;
098    
099            public java.io.File exportPortletInfoAsFile(long plid, long groupId,
100                    java.lang.String portletId,
101                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
102                    java.util.Date startDate, java.util.Date endDate)
103                    throws com.liferay.portal.kernel.exception.PortalException,
104                            com.liferay.portal.kernel.exception.SystemException;
105    
106            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
107            public long getDefaultPlid(long groupId, long scopeGroupId,
108                    boolean privateLayout, java.lang.String portletId)
109                    throws com.liferay.portal.kernel.exception.PortalException,
110                            com.liferay.portal.kernel.exception.SystemException;
111    
112            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
113            public java.lang.String getLayoutName(long groupId, boolean privateLayout,
114                    long layoutId, java.lang.String languageId)
115                    throws com.liferay.portal.kernel.exception.PortalException,
116                            com.liferay.portal.kernel.exception.SystemException;
117    
118            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
119            public com.liferay.portal.model.LayoutReference[] getLayoutReferences(
120                    long companyId, java.lang.String portletId,
121                    java.lang.String preferencesKey, java.lang.String preferencesValue)
122                    throws com.liferay.portal.kernel.exception.SystemException;
123    
124            public void importLayouts(long groupId, boolean privateLayout,
125                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
126                    byte[] bytes)
127                    throws com.liferay.portal.kernel.exception.PortalException,
128                            com.liferay.portal.kernel.exception.SystemException;
129    
130            public void importLayouts(long groupId, boolean privateLayout,
131                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
132                    java.io.File file)
133                    throws com.liferay.portal.kernel.exception.PortalException,
134                            com.liferay.portal.kernel.exception.SystemException;
135    
136            public void importLayouts(long groupId, boolean privateLayout,
137                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
138                    java.io.InputStream is)
139                    throws com.liferay.portal.kernel.exception.PortalException,
140                            com.liferay.portal.kernel.exception.SystemException;
141    
142            public void importPortletInfo(long plid, long groupId,
143                    java.lang.String portletId,
144                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
145                    java.io.File file)
146                    throws com.liferay.portal.kernel.exception.PortalException,
147                            com.liferay.portal.kernel.exception.SystemException;
148    
149            public void importPortletInfo(long plid, long groupId,
150                    java.lang.String portletId,
151                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
152                    java.io.InputStream is)
153                    throws com.liferay.portal.kernel.exception.PortalException,
154                            com.liferay.portal.kernel.exception.SystemException;
155    
156            public void schedulePublishToLive(long sourceGroupId, long targetGroupId,
157                    boolean privateLayout,
158                    java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap,
159                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
160                    java.lang.String scope, java.util.Date startDate,
161                    java.util.Date endDate, java.lang.String groupName,
162                    java.lang.String cronText, java.util.Date schedulerStartDate,
163                    java.util.Date schedulerEndDate, java.lang.String description)
164                    throws com.liferay.portal.kernel.exception.PortalException,
165                            com.liferay.portal.kernel.exception.SystemException;
166    
167            public void schedulePublishToRemote(long sourceGroupId,
168                    boolean privateLayout,
169                    java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap,
170                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
171                    java.lang.String remoteAddress, int remotePort,
172                    boolean secureConnection, long remoteGroupId,
173                    boolean remotePrivateLayout, java.util.Date startDate,
174                    java.util.Date endDate, java.lang.String groupName,
175                    java.lang.String cronText, java.util.Date schedulerStartDate,
176                    java.util.Date schedulerEndDate, java.lang.String description)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException;
179    
180            public void setLayouts(long groupId, boolean privateLayout,
181                    long parentLayoutId, long[] layoutIds)
182                    throws com.liferay.portal.kernel.exception.PortalException,
183                            com.liferay.portal.kernel.exception.SystemException;
184    
185            public void unschedulePublishToLive(long groupId, java.lang.String jobName,
186                    java.lang.String groupName)
187                    throws com.liferay.portal.kernel.exception.PortalException,
188                            com.liferay.portal.kernel.exception.SystemException;
189    
190            public void unschedulePublishToRemote(long groupId,
191                    java.lang.String jobName, java.lang.String groupName)
192                    throws com.liferay.portal.kernel.exception.PortalException,
193                            com.liferay.portal.kernel.exception.SystemException;
194    
195            public com.liferay.portal.model.Layout updateLayout(long groupId,
196                    boolean privateLayout, long layoutId, long parentLayoutId,
197                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
198                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
199                    java.lang.String description, java.lang.String type, boolean hidden,
200                    java.lang.String friendlyURL, java.lang.Boolean iconImage,
201                    byte[] iconBytes,
202                    com.liferay.portal.service.ServiceContext serviceContext)
203                    throws com.liferay.portal.kernel.exception.PortalException,
204                            com.liferay.portal.kernel.exception.SystemException;
205    
206            public com.liferay.portal.model.Layout updateLayout(long groupId,
207                    boolean privateLayout, long layoutId, long parentLayoutId,
208                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
209                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
210                    java.lang.String description, java.lang.String type, boolean hidden,
211                    java.lang.String friendlyURL,
212                    com.liferay.portal.service.ServiceContext serviceContext)
213                    throws com.liferay.portal.kernel.exception.PortalException,
214                            com.liferay.portal.kernel.exception.SystemException;
215    
216            public com.liferay.portal.model.Layout updateLayout(long groupId,
217                    boolean privateLayout, long layoutId, java.lang.String typeSettings)
218                    throws com.liferay.portal.kernel.exception.PortalException,
219                            com.liferay.portal.kernel.exception.SystemException;
220    
221            public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
222                    boolean privateLayout, long layoutId, java.lang.String themeId,
223                    java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
224                    throws com.liferay.portal.kernel.exception.PortalException,
225                            com.liferay.portal.kernel.exception.SystemException;
226    
227            public com.liferay.portal.model.Layout updateName(long groupId,
228                    boolean privateLayout, long layoutId, java.lang.String name,
229                    java.lang.String languageId)
230                    throws com.liferay.portal.kernel.exception.PortalException,
231                            com.liferay.portal.kernel.exception.SystemException;
232    
233            public com.liferay.portal.model.Layout updateName(long plid,
234                    java.lang.String name, java.lang.String languageId)
235                    throws com.liferay.portal.kernel.exception.PortalException,
236                            com.liferay.portal.kernel.exception.SystemException;
237    
238            public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
239                    boolean privateLayout, long layoutId, long parentLayoutId)
240                    throws com.liferay.portal.kernel.exception.PortalException,
241                            com.liferay.portal.kernel.exception.SystemException;
242    
243            public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
244                    long parentPlid)
245                    throws com.liferay.portal.kernel.exception.PortalException,
246                            com.liferay.portal.kernel.exception.SystemException;
247    
248            public com.liferay.portal.model.Layout updatePriority(long groupId,
249                    boolean privateLayout, long layoutId, int priority)
250                    throws com.liferay.portal.kernel.exception.PortalException,
251                            com.liferay.portal.kernel.exception.SystemException;
252    
253            public com.liferay.portal.model.Layout updatePriority(long plid,
254                    int priority)
255                    throws com.liferay.portal.kernel.exception.PortalException,
256                            com.liferay.portal.kernel.exception.SystemException;
257    }