001
014
015 package com.liferay.portal.service;
016
017 import aQute.bnd.annotation.ProviderType;
018
019 import com.liferay.portal.kernel.cluster.Clusterable;
020 import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
021 import com.liferay.portal.kernel.dao.orm.DynamicQuery;
022 import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
023 import com.liferay.portal.kernel.dao.orm.Projection;
024 import com.liferay.portal.kernel.exception.PortalException;
025 import com.liferay.portal.kernel.exception.SystemException;
026 import com.liferay.portal.kernel.plugin.PluginPackage;
027 import com.liferay.portal.kernel.portlet.FriendlyURLMapper;
028 import com.liferay.portal.kernel.search.Indexable;
029 import com.liferay.portal.kernel.search.IndexableType;
030 import com.liferay.portal.kernel.spring.aop.Skip;
031 import com.liferay.portal.kernel.transaction.Isolation;
032 import com.liferay.portal.kernel.transaction.Propagation;
033 import com.liferay.portal.kernel.transaction.Transactional;
034 import com.liferay.portal.kernel.util.OrderByComparator;
035 import com.liferay.portal.model.PersistedModel;
036 import com.liferay.portal.model.Portlet;
037 import com.liferay.portal.model.PortletApp;
038 import com.liferay.portal.model.PortletCategory;
039
040 import com.liferay.portlet.expando.model.CustomAttributesDisplay;
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
072
078 @Indexable(type = IndexableType.REINDEX)
079 public Portlet addPortlet(Portlet portlet);
080
081 @Skip
082 public void addPortletCategory(long companyId, java.lang.String categoryName);
083
084 public void checkPortlet(Portlet portlet) throws PortalException;
085
086 public void checkPortlets(long companyId) throws PortalException;
087
088 @Skip
089 public void clearCache();
090
091
094 @Clusterable
095 @java.lang.Deprecated
096 @Transactional(enabled = false)
097 public void clearCompanyPortletsPool();
098
099 @Clusterable
100 @Transactional(enabled = false)
101 public void clearPortletsMap();
102
103 @Skip
104 public Portlet clonePortlet(java.lang.String portletId);
105
106
112 public Portlet createPortlet(long id);
113
114
117 @Override
118 public PersistedModel deletePersistedModel(PersistedModel persistedModel)
119 throws PortalException;
120
121 public void deletePortlet(long companyId, java.lang.String portletId,
122 long plid) throws PortalException;
123
124
131 @Indexable(type = IndexableType.DELETE)
132 public Portlet deletePortlet(long id) throws PortalException;
133
134
140 @Indexable(type = IndexableType.DELETE)
141 public Portlet deletePortlet(Portlet portlet);
142
143 public void deletePortlets(long companyId, java.lang.String[] portletIds,
144 long plid) throws PortalException;
145
146 public Portlet deployRemotePortlet(Portlet portlet,
147 java.lang.String categoryName) throws PortalException;
148
149 public Portlet deployRemotePortlet(Portlet portlet,
150 java.lang.String[] categoryNames) throws PortalException;
151
152 public Portlet deployRemotePortlet(Portlet portlet,
153 java.lang.String[] categoryNames, boolean eagerDestroy)
154 throws PortalException;
155
156 @Skip
157 public void destroyPortlet(Portlet portlet);
158
159 @Skip
160 public void destroyRemotePortlet(Portlet portlet);
161
162 public DynamicQuery dynamicQuery();
163
164
170 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery);
171
172
184 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
185 int end);
186
187
200 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
201 int end, OrderByComparator<T> orderByComparator);
202
203
209 public long dynamicQueryCount(DynamicQuery dynamicQuery);
210
211
218 public long dynamicQueryCount(DynamicQuery dynamicQuery,
219 Projection projection);
220
221 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
222 public Portlet fetchPortlet(long id);
223
224 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
225 public ActionableDynamicQuery getActionableDynamicQuery();
226
227 @Skip
228 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
229 public List<CustomAttributesDisplay> getCustomAttributesDisplays();
230
231 @Skip
232 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
233 public PortletCategory getEARDisplay(java.lang.String xml);
234
235 @Skip
236 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
237 public List<Portlet> getFriendlyURLMapperPortlets();
238
239 @Skip
240 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
241 public List<FriendlyURLMapper> getFriendlyURLMappers();
242
243 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
244 public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
245
246
251 public java.lang.String getOSGiServiceIdentifier();
252
253 @Override
254 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
255 public PersistedModel getPersistedModel(Serializable primaryKeyObj)
256 throws PortalException;
257
258
265 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
266 public Portlet getPortlet(long id) throws PortalException;
267
268 @Skip
269 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
270 public PortletApp getPortletApp(java.lang.String servletContextName);
271
272 @Skip
273 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
274 public Portlet getPortletById(long companyId, java.lang.String portletId);
275
276 @Skip
277 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
278 public Portlet getPortletById(java.lang.String portletId);
279
280 @Skip
281 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
282 public Portlet getPortletByStrutsPath(long companyId,
283 java.lang.String strutsPath);
284
285 @Skip
286 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
287 public List<Portlet> getPortlets();
288
289 @Skip
290 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
291 public List<Portlet> getPortlets(long companyId);
292
293 @Skip
294 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
295 public List<Portlet> getPortlets(long companyId, boolean showSystem,
296 boolean showPortal);
297
298
309 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
310 public List<Portlet> getPortlets(int start, int end);
311
312
317 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
318 public int getPortletsCount();
319
320 @Skip
321 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
322 public List<Portlet> getScopablePortlets();
323
324 @Skip
325 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
326 public PortletCategory getWARDisplay(java.lang.String servletContextName,
327 java.lang.String xml);
328
329 @Skip
330 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
331 public boolean hasPortlet(long companyId, java.lang.String portletId);
332
333 @Skip
334 public void initEAR(ServletContext servletContext, java.lang.String[] xmls,
335 PluginPackage pluginPackage);
336
337 @Skip
338 public List<Portlet> initWAR(java.lang.String servletContextName,
339 ServletContext servletContext, java.lang.String[] xmls,
340 PluginPackage pluginPackage);
341
342 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
343 public Map<java.lang.String, Portlet> loadGetPortletsMap(long companyId);
344
345
348 @java.lang.Deprecated
349 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
350 public Map<java.lang.String, Portlet> loadGetPortletsPool(long companyId);
351
352 @Clusterable
353 @Transactional(enabled = false)
354 public void removeCompanyPortletsPool(long companyId);
355
356 public Portlet updatePortlet(long companyId, java.lang.String portletId,
357 java.lang.String roles, boolean active);
358
359
365 @Indexable(type = IndexableType.REINDEX)
366 public Portlet updatePortlet(Portlet portlet);
367 }