com.liferay.portal.kernel.service

Interface PortletLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

PortletLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface PortletLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for Portlet. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

Author:

Brian Wing Shun Chan

See Also:

PortletLocalServiceUtil, PortletLocalServiceBaseImpl, PortletLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
Portlet	addPortlet(Portlet portlet) Adds the portlet to the database.
void	addPortletCategory(long companyId, String categoryName)
void	checkPortlet(Portlet portlet)
void	checkPortlets(long companyId)
void	clearCache()
void	clearCompanyPortletsPool() Deprecated. As of Wilberforce (7.0.x), replaced by #clearPortletsMap)
void	clearPortletsMap()
Portlet	clonePortlet(String portletId)
Portlet	createPortlet(long id) Creates a new portlet with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
Portlet	deletePortlet(long id) Deletes the portlet with the primary key from the database.
void	deletePortlet(long companyId, String portletId, long plid)
Portlet	deletePortlet(Portlet portlet) Deletes the portlet from the database.
void	deletePortlets(long companyId, String[] portletIds, long plid)
void	deployPortlet(Portlet portlet)
Portlet	deployRemotePortlet(Portlet portlet, String categoryName)
Portlet	deployRemotePortlet(Portlet portlet, String[] categoryNames)
Portlet	deployRemotePortlet(Portlet portlet, String[] categoryNames, boolean eagerDestroy)
void	destroyPortlet(Portlet portlet)
void	destroyRemotePortlet(Portlet portlet)
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
Portlet	fetchPortlet(long id)
Portlet	fetchPortletById(long companyId, String portletId)
ActionableDynamicQuery	getActionableDynamicQuery()
List<CustomAttributesDisplay>	getCustomAttributesDisplays()
PortletCategory	getEARDisplay(String xml)
List<Portlet>	getFriendlyURLMapperPortlets()
List<FriendlyURLMapper>	getFriendlyURLMappers()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
Portlet	getPortlet(long id) Returns the portlet with the primary key.
PortletApp	getPortletApp(String servletContextName)
Portlet	getPortletById(long companyId, String portletId)
Portlet	getPortletById(String portletId)
Portlet	getPortletByStrutsPath(long companyId, String strutsPath)
List<Portlet>	getPortlets()
List<Portlet>	getPortlets(int start, int end) Returns a range of all the portlets.
List<Portlet>	getPortlets(long companyId)
List<Portlet>	getPortlets(long companyId, boolean showSystem, boolean showPortal)
int	getPortletsCount() Returns the number of portlets.
List<Portlet>	getScopablePortlets()
PortletCategory	getWARDisplay(String servletContextName, String xml)
boolean	hasPortlet(long companyId, String portletId)
void	initEAR(javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage)
List<Portlet>	initWAR(String servletContextName, javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage)
Map<String,Portlet>	loadGetPortletsMap(long companyId)
Map<String,Portlet>	loadGetPortletsPool(long companyId) Deprecated. As of Wilberforce (7.0.x), replaced by #loadGetPortletsMap(long))
void	removeCompanyPortletsPool(long companyId)
Portlet	updatePortlet(long companyId, String portletId, String roles, boolean active)
Portlet	updatePortlet(Portlet portlet) Updates the portlet in the database or adds it if it does not yet exist.
void	visitPortlets(long companyId, Consumer<Portlet> consumer)

Method Detail

addPortlet

@Indexable(type=REINDEX)
Portlet addPortlet(Portlet portlet)

Adds the portlet to the database. Also notifies the appropriate model listeners.

Parameters:

portlet - the portlet

Returns:

the portlet that was added

addPortletCategory

@Skip
void addPortletCategory(long companyId,
                              String categoryName)

checkPortlet

void checkPortlet(Portlet portlet)
           throws PortalException

Throws:

PortalException

checkPortlets

void checkPortlets(long companyId)
            throws PortalException

Throws:

PortalException

clearCache

@Skip
void clearCache()

clearCompanyPortletsPool

@Clusterable
 @Deprecated
 @Transactional(enabled=false)
void clearCompanyPortletsPool()

Deprecated. As of Wilberforce (7.0.x), replaced by #clearPortletsMap)

clearPortletsMap

@Clusterable
 @Transactional(enabled=false)
void clearPortletsMap()

clonePortlet

@Skip
Portlet clonePortlet(String portletId)

createPortlet

@Transactional(enabled=false)
Portlet createPortlet(long id)

Creates a new portlet with the primary key. Does not add the portlet to the database.

Parameters:

id - the primary key for the new portlet

Returns:

the new portlet

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deletePortlet

@Indexable(type=DELETE)
Portlet deletePortlet(long id)
                                       throws PortalException

Deletes the portlet with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

id - the primary key of the portlet

Returns:

the portlet that was removed

Throws:

PortalException - if a portlet with the primary key could not be found

deletePortlet

void deletePortlet(long companyId,
                   String portletId,
                   long plid)
            throws PortalException

Throws:

PortalException

deletePortlet

@Indexable(type=DELETE)
Portlet deletePortlet(Portlet portlet)

Deletes the portlet from the database. Also notifies the appropriate model listeners.

Parameters:

portlet - the portlet

Returns:

the portlet that was removed

deletePortlets

void deletePortlets(long companyId,
                    String[] portletIds,
                    long plid)
             throws PortalException

Throws:

PortalException

deployPortlet

@Skip
void deployPortlet(Portlet portlet)
                  throws Exception

Throws:

Exception

deployRemotePortlet

Portlet deployRemotePortlet(Portlet portlet,
                            String categoryName)
                     throws PortalException

Throws:

PortalException

deployRemotePortlet

Portlet deployRemotePortlet(Portlet portlet,
                            String[] categoryNames)
                     throws PortalException

Throws:

PortalException

deployRemotePortlet

Portlet deployRemotePortlet(Portlet portlet,
                            String[] categoryNames,
                            boolean eagerDestroy)
                     throws PortalException

Throws:

PortalException

destroyPortlet

@Skip
void destroyPortlet(Portlet portlet)

destroyRemotePortlet

@Skip
void destroyRemotePortlet(Portlet portlet)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end)

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PortletModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end,
                                                                                            OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PortletModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery,
                                                                                          Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchPortlet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Portlet fetchPortlet(long id)

fetchPortletById

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
Portlet fetchPortletById(long companyId,
                                                                                                   String portletId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getCustomAttributesDisplays

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
List<CustomAttributesDisplay> getCustomAttributesDisplays()

getEARDisplay

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletCategory getEARDisplay(String xml)

getFriendlyURLMapperPortlets

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Portlet> getFriendlyURLMapperPortlets()

getFriendlyURLMappers

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
List<FriendlyURLMapper> getFriendlyURLMappers()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getPortlet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Portlet getPortlet(long id)
                                                                               throws PortalException

Returns the portlet with the primary key.

Parameters:

id - the primary key of the portlet

Returns:

the portlet

Throws:

PortalException - if a portlet with the primary key could not be found

getPortletApp

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletApp getPortletApp(String servletContextName)

getPortletById

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
Portlet getPortletById(long companyId,
                                                                                                 String portletId)

getPortletById

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
Portlet getPortletById(String portletId)

getPortletByStrutsPath

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
Portlet getPortletByStrutsPath(long companyId,
                                                                                                         String strutsPath)

getPortlets

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Portlet> getPortlets()

getPortlets

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Portlet> getPortlets(int start,
                                                                                             int end)

Returns a range of all the portlets.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PortletModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of portlets

end - the upper bound of the range of portlets (not inclusive)

Returns:

the range of portlets

getPortlets

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Portlet> getPortlets(long companyId)

getPortlets

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Portlet> getPortlets(long companyId,
                                                                                                    boolean showSystem,
                                                                                                    boolean showPortal)

getPortletsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPortletsCount()

Returns the number of portlets.

Returns:

the number of portlets

getScopablePortlets

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Portlet> getScopablePortlets()

getWARDisplay

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletCategory getWARDisplay(String servletContextName,
                                                                                                        String xml)

hasPortlet

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasPortlet(long companyId,
                                                                                             String portletId)

initEAR

@Skip
void initEAR(javax.servlet.ServletContext servletContext,
                   String[] xmls,
                   PluginPackage pluginPackage)

initWAR

@Skip
List<Portlet> initWAR(String servletContextName,
                            javax.servlet.ServletContext servletContext,
                            String[] xmls,
                            PluginPackage pluginPackage)

loadGetPortletsMap

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Map<String,Portlet> loadGetPortletsMap(long companyId)

loadGetPortletsPool

@Deprecated
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
Map<String,Portlet> loadGetPortletsPool(long companyId)

Deprecated. As of Wilberforce (7.0.x), replaced by #loadGetPortletsMap(long))

removeCompanyPortletsPool

@Clusterable
 @Transactional(enabled=false)
void removeCompanyPortletsPool(long companyId)

updatePortlet

Portlet updatePortlet(long companyId,
                      String portletId,
                      String roles,
                      boolean active)

updatePortlet

@Indexable(type=REINDEX)
Portlet updatePortlet(Portlet portlet)

Updates the portlet in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

portlet - the portlet

Returns:

the portlet that was updated

visitPortlets

@Skip
void visitPortlets(long companyId,
                         Consumer<Portlet> consumer)