001
014
015 package com.liferay.portal.kernel.service;
016
017 import aQute.bnd.annotation.ProviderType;
018
019 import com.liferay.expando.kernel.model.CustomAttributesDisplay;
020
021 import com.liferay.portal.kernel.cluster.Clusterable;
022 import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
023 import com.liferay.portal.kernel.dao.orm.DynamicQuery;
024 import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
025 import com.liferay.portal.kernel.dao.orm.Projection;
026 import com.liferay.portal.kernel.exception.PortalException;
027 import com.liferay.portal.kernel.exception.SystemException;
028 import com.liferay.portal.kernel.model.PersistedModel;
029 import com.liferay.portal.kernel.model.Portlet;
030 import com.liferay.portal.kernel.model.PortletApp;
031 import com.liferay.portal.kernel.model.PortletCategory;
032 import com.liferay.portal.kernel.plugin.PluginPackage;
033 import com.liferay.portal.kernel.portlet.FriendlyURLMapper;
034 import com.liferay.portal.kernel.search.Indexable;
035 import com.liferay.portal.kernel.search.IndexableType;
036 import com.liferay.portal.kernel.spring.aop.Skip;
037 import com.liferay.portal.kernel.transaction.Isolation;
038 import com.liferay.portal.kernel.transaction.Propagation;
039 import com.liferay.portal.kernel.transaction.Transactional;
040 import com.liferay.portal.kernel.util.OrderByComparator;
041
042 import java.io.Serializable;
043
044 import java.util.List;
045 import java.util.Map;
046
047 import javax.servlet.ServletContext;
048
049
061 @ProviderType
062 @Transactional(isolation = Isolation.PORTAL, rollbackFor = {
063 PortalException.class, SystemException.class})
064 public interface PortletLocalService extends BaseLocalService,
065 PersistedModelLocalService {
066
071 @Skip
072 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
073 public boolean hasPortlet(long companyId, java.lang.String portletId);
074
075 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
076 public ActionableDynamicQuery getActionableDynamicQuery();
077
078 public DynamicQuery dynamicQuery();
079
080 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
081 public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
082
083
086 @Override
087 public PersistedModel deletePersistedModel(PersistedModel persistedModel)
088 throws PortalException;
089
090 @Override
091 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
092 public PersistedModel getPersistedModel(Serializable primaryKeyObj)
093 throws PortalException;
094
095
101 @Indexable(type = IndexableType.REINDEX)
102 public Portlet addPortlet(Portlet portlet);
103
104 @Skip
105 public Portlet clonePortlet(java.lang.String portletId);
106
107
113 public Portlet createPortlet(long id);
114
115
121 @Indexable(type = IndexableType.DELETE)
122 public Portlet deletePortlet(Portlet portlet);
123
124
131 @Indexable(type = IndexableType.DELETE)
132 public Portlet deletePortlet(long id) throws PortalException;
133
134 public Portlet deployRemotePortlet(Portlet portlet,
135 java.lang.String categoryName) throws PortalException;
136
137 public Portlet deployRemotePortlet(Portlet portlet,
138 java.lang.String[] categoryNames) throws PortalException;
139
140 public Portlet deployRemotePortlet(Portlet portlet,
141 java.lang.String[] categoryNames, boolean eagerDestroy)
142 throws PortalException;
143
144 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
145 public Portlet fetchPortlet(long id);
146
147
154 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155 public Portlet getPortlet(long id) throws PortalException;
156
157 @Skip
158 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
159 public Portlet getPortletById(java.lang.String portletId);
160
161 @Skip
162 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
163 public Portlet getPortletById(long companyId, java.lang.String portletId);
164
165 @Skip
166 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
167 public Portlet getPortletByStrutsPath(long companyId,
168 java.lang.String strutsPath);
169
170
176 @Indexable(type = IndexableType.REINDEX)
177 public Portlet updatePortlet(Portlet portlet);
178
179 public Portlet updatePortlet(long companyId, java.lang.String portletId,
180 java.lang.String roles, boolean active);
181
182 @Skip
183 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184 public PortletApp getPortletApp(java.lang.String servletContextName);
185
186 @Skip
187 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188 public PortletCategory getEARDisplay(java.lang.String xml);
189
190 @Skip
191 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
192 public PortletCategory getWARDisplay(java.lang.String servletContextName,
193 java.lang.String xml);
194
195
200 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
201 public int getPortletsCount();
202
203
208 public java.lang.String getOSGiServiceIdentifier();
209
210
216 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery);
217
218
230 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
231 int end);
232
233
246 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
247 int end, OrderByComparator<T> orderByComparator);
248
249 @Skip
250 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
251 public List<CustomAttributesDisplay> getCustomAttributesDisplays();
252
253 @Skip
254 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
255 public List<Portlet> getFriendlyURLMapperPortlets();
256
257 @Skip
258 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
259 public List<FriendlyURLMapper> getFriendlyURLMappers();
260
261 @Skip
262 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
263 public List<Portlet> getPortlets();
264
265
276 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
277 public List<Portlet> getPortlets(int start, int end);
278
279 @Skip
280 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
281 public List<Portlet> getPortlets(long companyId);
282
283 @Skip
284 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
285 public List<Portlet> getPortlets(long companyId, boolean showSystem,
286 boolean showPortal);
287
288 @Skip
289 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
290 public List<Portlet> getScopablePortlets();
291
292 @Skip
293 public List<Portlet> initWAR(java.lang.String servletContextName,
294 ServletContext servletContext, java.lang.String[] xmls,
295 PluginPackage pluginPackage);
296
297 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
298 public Map<java.lang.String, Portlet> loadGetPortletsMap(long companyId);
299
300
303 @java.lang.Deprecated
304 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
305 public Map<java.lang.String, Portlet> loadGetPortletsPool(long companyId);
306
307
313 public long dynamicQueryCount(DynamicQuery dynamicQuery);
314
315
322 public long dynamicQueryCount(DynamicQuery dynamicQuery,
323 Projection projection);
324
325 @Skip
326 public void addPortletCategory(long companyId, java.lang.String categoryName);
327
328 public void checkPortlet(Portlet portlet) throws PortalException;
329
330 public void checkPortlets(long companyId) throws PortalException;
331
332 @Skip
333 public void clearCache();
334
335
338 @Clusterable
339 @java.lang.Deprecated
340 @Transactional(enabled = false)
341 public void clearCompanyPortletsPool();
342
343 @Clusterable
344 @Transactional(enabled = false)
345 public void clearPortletsMap();
346
347 public void deletePortlet(long companyId, java.lang.String portletId,
348 long plid) throws PortalException;
349
350 public void deletePortlets(long companyId, java.lang.String[] portletIds,
351 long plid) throws PortalException;
352
353 @Skip
354 public void destroyPortlet(Portlet portlet);
355
356 @Skip
357 public void destroyRemotePortlet(Portlet portlet);
358
359 @Skip
360 public void initEAR(ServletContext servletContext, java.lang.String[] xmls,
361 PluginPackage pluginPackage);
362
363 @Clusterable
364 @Transactional(enabled = false)
365 public void removeCompanyPortletsPool(long companyId);
366 }