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="LayoutService.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.LayoutServiceImpl</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 remote service. Methods of this service are expected to have security
41   * checks based on the propagated JAAS credentials because this service can be accessed
42   * 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 com.liferay.portal.SystemException, 
57              com.liferay.portal.PortalException, java.rmi.RemoteException;
58  
59      public void deleteLayout(long plid)
60          throws com.liferay.portal.SystemException, 
61              com.liferay.portal.PortalException, java.rmi.RemoteException;
62  
63      public void deleteLayout(long groupId, boolean privateLayout, long layoutId)
64          throws com.liferay.portal.SystemException, 
65              com.liferay.portal.PortalException, java.rmi.RemoteException;
66  
67      public java.lang.String getLayoutName(long groupId, boolean privateLayout,
68          long layoutId, java.lang.String languageId)
69          throws com.liferay.portal.SystemException, 
70              com.liferay.portal.PortalException, java.rmi.RemoteException;
71  
72      public com.liferay.portal.model.LayoutReference[] getLayoutReferences(
73          long companyId, java.lang.String portletId, java.lang.String prefsKey,
74          java.lang.String prefsValue)
75          throws com.liferay.portal.SystemException, java.rmi.RemoteException;
76  
77      public byte[] exportLayouts(long groupId, boolean privateLayout,
78          java.util.Map parameterMap)
79          throws com.liferay.portal.SystemException, 
80              com.liferay.portal.PortalException, java.rmi.RemoteException;
81  
82      public void importLayouts(long groupId, boolean privateLayout,
83          java.util.Map parameterMap, java.io.File file)
84          throws com.liferay.portal.SystemException, 
85              com.liferay.portal.PortalException, java.rmi.RemoteException;
86  
87      public void setLayouts(long groupId, boolean privateLayout,
88          long parentLayoutId, long[] layoutIds)
89          throws com.liferay.portal.SystemException, 
90              com.liferay.portal.PortalException, java.rmi.RemoteException;
91  
92      public com.liferay.portal.model.Layout updateLayout(long groupId,
93          boolean privateLayout, long layoutId, long parentLayoutId,
94          java.lang.String name, java.lang.String title,
95          java.lang.String languageId, java.lang.String description,
96          java.lang.String type, boolean hidden, java.lang.String friendlyURL)
97          throws com.liferay.portal.SystemException, 
98              com.liferay.portal.PortalException, java.rmi.RemoteException;
99  
100     public com.liferay.portal.model.Layout updateLayout(long groupId,
101         boolean privateLayout, long layoutId, long parentLayoutId,
102         java.lang.String name, java.lang.String title,
103         java.lang.String languageId, java.lang.String description,
104         java.lang.String type, boolean hidden, java.lang.String friendlyURL,
105         java.lang.Boolean iconImage, byte[] iconBytes)
106         throws com.liferay.portal.SystemException, 
107             com.liferay.portal.PortalException, java.rmi.RemoteException;
108 
109     public com.liferay.portal.model.Layout updateLayout(long groupId,
110         boolean privateLayout, long layoutId, java.lang.String typeSettings)
111         throws com.liferay.portal.SystemException, 
112             com.liferay.portal.PortalException, java.rmi.RemoteException;
113 
114     public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
115         boolean privateLayout, long layoutId, java.lang.String themeId,
116         java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
117         throws com.liferay.portal.SystemException, 
118             com.liferay.portal.PortalException, java.rmi.RemoteException;
119 
120     public com.liferay.portal.model.Layout updateName(long plid,
121         java.lang.String name, java.lang.String languageId)
122         throws com.liferay.portal.SystemException, 
123             com.liferay.portal.PortalException, java.rmi.RemoteException;
124 
125     public com.liferay.portal.model.Layout updateName(long groupId,
126         boolean privateLayout, long layoutId, java.lang.String name,
127         java.lang.String languageId)
128         throws com.liferay.portal.SystemException, 
129             com.liferay.portal.PortalException, java.rmi.RemoteException;
130 
131     public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
132         long parentPlid)
133         throws com.liferay.portal.SystemException, 
134             com.liferay.portal.PortalException, java.rmi.RemoteException;
135 
136     public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
137         boolean privateLayout, long layoutId, long parentLayoutId)
138         throws com.liferay.portal.SystemException, 
139             com.liferay.portal.PortalException, java.rmi.RemoteException;
140 
141     public com.liferay.portal.model.Layout updatePriority(long plid,
142         int priority)
143         throws com.liferay.portal.SystemException, 
144             com.liferay.portal.PortalException, java.rmi.RemoteException;
145 
146     public com.liferay.portal.model.Layout updatePriority(long groupId,
147         boolean privateLayout, long layoutId, int priority)
148         throws com.liferay.portal.SystemException, 
149             com.liferay.portal.PortalException, java.rmi.RemoteException;
150 }