com.liferay.portal.kernel.service

Class PortletLocalServiceWrapper

Object

com.liferay.portal.kernel.service.PortletLocalServiceWrapper

All Implemented Interfaces:

BaseLocalService, PersistedModelLocalService, PortletLocalService, ServiceWrapper<PortletLocalService>

@ProviderType
public class PortletLocalServiceWrapper
extends Object
implements PortletLocalService, ServiceWrapper<PortletLocalService>

Provides a wrapper for PortletLocalService.

Author:

Brian Wing Shun Chan

See Also:

PortletLocalService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
PortletLocalServiceWrapper(PortletLocalService portletLocalService)

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)
PortletLocalService	getWrappedService()
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)
void	setWrappedService(PortletLocalService portletLocalService)
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)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortletLocalServiceWrapper

public PortletLocalServiceWrapper(PortletLocalService portletLocalService)

Method Detail

addPortlet

public Portlet addPortlet(Portlet portlet)

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

Specified by:

addPortlet in interface PortletLocalService

Parameters:

portlet - the portlet

Returns:

the portlet that was added

addPortletCategory

public void addPortletCategory(long companyId,
                               String categoryName)

Specified by:

addPortletCategory in interface PortletLocalService

checkPortlet

public void checkPortlet(Portlet portlet)
                  throws PortalException

Specified by:

checkPortlet in interface PortletLocalService

Throws:

PortalException

checkPortlets

public void checkPortlets(long companyId)
                   throws PortalException

Specified by:

checkPortlets in interface PortletLocalService

Throws:

PortalException

clearCache

public void clearCache()

Specified by:

clearCache in interface PortletLocalService

clearCompanyPortletsPool

@Deprecated
public void clearCompanyPortletsPool()

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

Specified by:

clearCompanyPortletsPool in interface PortletLocalService

clearPortletsMap

public void clearPortletsMap()

Specified by:

clearPortletsMap in interface PortletLocalService

clonePortlet

public Portlet clonePortlet(String portletId)

Specified by:

clonePortlet in interface PortletLocalService

createPortlet

public Portlet createPortlet(long id)

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

Specified by:

createPortlet in interface PortletLocalService

Parameters:

id - the primary key for the new portlet

Returns:

the new portlet

deletePersistedModel

public PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Specified by:

deletePersistedModel in interface PortletLocalService

Throws:

PortalException

deletePortlet

public Portlet deletePortlet(long id)
                      throws PortalException

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

Specified by:

deletePortlet in interface PortletLocalService

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

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

Specified by:

deletePortlet in interface PortletLocalService

Throws:

PortalException

deletePortlet

public Portlet deletePortlet(Portlet portlet)

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

Specified by:

deletePortlet in interface PortletLocalService

Parameters:

portlet - the portlet

Returns:

the portlet that was removed

deletePortlets

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

Specified by:

deletePortlets in interface PortletLocalService

Throws:

PortalException

deployPortlet

public void deployPortlet(Portlet portlet)
                   throws Exception

Specified by:

deployPortlet in interface PortletLocalService

Throws:

Exception

deployRemotePortlet

public Portlet deployRemotePortlet(Portlet portlet,
                                   String categoryName)
                            throws PortalException

Specified by:

deployRemotePortlet in interface PortletLocalService

Throws:

PortalException

deployRemotePortlet

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

Specified by:

deployRemotePortlet in interface PortletLocalService

Throws:

PortalException

deployRemotePortlet

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

Specified by:

deployRemotePortlet in interface PortletLocalService

Throws:

PortalException

destroyPortlet

public void destroyPortlet(Portlet portlet)

Specified by:

destroyPortlet in interface PortletLocalService

destroyRemotePortlet

public void destroyRemotePortlet(Portlet portlet)

Specified by:

destroyRemotePortlet in interface PortletLocalService

dynamicQuery

public DynamicQuery dynamicQuery()

Specified by:

dynamicQuery in interface PortletLocalService

dynamicQuery

public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

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

Specified by:

dynamicQuery in interface PortletLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public <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.

Specified by:

dynamicQuery in interface PortletLocalService

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

public <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.

Specified by:

dynamicQuery in interface PortletLocalService

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

public long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Specified by:

dynamicQueryCount in interface PortletLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery,
                              Projection projection)

Returns the number of rows matching the dynamic query.

Specified by:

dynamicQueryCount in interface PortletLocalService

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchPortlet

public Portlet fetchPortlet(long id)

Specified by:

fetchPortlet in interface PortletLocalService

fetchPortletById

public Portlet fetchPortletById(long companyId,
                                String portletId)

Specified by:

fetchPortletById in interface PortletLocalService

getActionableDynamicQuery

public ActionableDynamicQuery getActionableDynamicQuery()

Specified by:

getActionableDynamicQuery in interface PortletLocalService

getCustomAttributesDisplays

public List<CustomAttributesDisplay> getCustomAttributesDisplays()

Specified by:

getCustomAttributesDisplays in interface PortletLocalService

getEARDisplay

public PortletCategory getEARDisplay(String xml)

Specified by:

getEARDisplay in interface PortletLocalService

getFriendlyURLMapperPortlets

public List<Portlet> getFriendlyURLMapperPortlets()

Specified by:

getFriendlyURLMapperPortlets in interface PortletLocalService

getFriendlyURLMappers

public List<FriendlyURLMapper> getFriendlyURLMappers()

Specified by:

getFriendlyURLMappers in interface PortletLocalService

getIndexableActionableDynamicQuery

public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

Specified by:

getIndexableActionableDynamicQuery in interface PortletLocalService

getOSGiServiceIdentifier

public String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Specified by:

getOSGiServiceIdentifier in interface PortletLocalService

Returns:

the OSGi service identifier

getPersistedModel

public PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Specified by:

getPersistedModel in interface PortletLocalService

Throws:

PortalException

getPortlet

public Portlet getPortlet(long id)
                   throws PortalException

Returns the portlet with the primary key.

Specified by:

getPortlet in interface PortletLocalService

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

public PortletApp getPortletApp(String servletContextName)

Specified by:

getPortletApp in interface PortletLocalService

getPortletById

public Portlet getPortletById(long companyId,
                              String portletId)

Specified by:

getPortletById in interface PortletLocalService

getPortletById

public Portlet getPortletById(String portletId)

Specified by:

getPortletById in interface PortletLocalService

getPortletByStrutsPath

public Portlet getPortletByStrutsPath(long companyId,
                                      String strutsPath)

Specified by:

getPortletByStrutsPath in interface PortletLocalService

getPortlets

public List<Portlet> getPortlets()

Specified by:

getPortlets in interface PortletLocalService

getPortlets

public 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.

Specified by:

getPortlets in interface PortletLocalService

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

public List<Portlet> getPortlets(long companyId)

Specified by:

getPortlets in interface PortletLocalService

getPortlets

public List<Portlet> getPortlets(long companyId,
                                 boolean showSystem,
                                 boolean showPortal)

Specified by:

getPortlets in interface PortletLocalService

getPortletsCount

public int getPortletsCount()

Returns the number of portlets.

Specified by:

getPortletsCount in interface PortletLocalService

Returns:

the number of portlets

getScopablePortlets

public List<Portlet> getScopablePortlets()

Specified by:

getScopablePortlets in interface PortletLocalService

getWARDisplay

public PortletCategory getWARDisplay(String servletContextName,
                                     String xml)

Specified by:

getWARDisplay in interface PortletLocalService

hasPortlet

public boolean hasPortlet(long companyId,
                          String portletId)

Specified by:

hasPortlet in interface PortletLocalService

initEAR

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

Specified by:

initEAR in interface PortletLocalService

initWAR

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

Specified by:

initWAR in interface PortletLocalService

loadGetPortletsMap

public Map<String,Portlet> loadGetPortletsMap(long companyId)

Specified by:

loadGetPortletsMap in interface PortletLocalService

loadGetPortletsPool

@Deprecated
public Map<String,Portlet> loadGetPortletsPool(long companyId)

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

Specified by:

loadGetPortletsPool in interface PortletLocalService

removeCompanyPortletsPool

public void removeCompanyPortletsPool(long companyId)

Specified by:

removeCompanyPortletsPool in interface PortletLocalService

updatePortlet

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

Specified by:

updatePortlet in interface PortletLocalService

updatePortlet

public 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.

Specified by:

updatePortlet in interface PortletLocalService

Parameters:

portlet - the portlet

Returns:

the portlet that was updated

visitPortlets

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

Specified by:

visitPortlets in interface PortletLocalService

getWrappedService

public PortletLocalService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<PortletLocalService>

setWrappedService

public void setWrappedService(PortletLocalService portletLocalService)

Specified by:

setWrappedService in interface ServiceWrapper<PortletLocalService>