com.liferay.portal.service

Class PortletLocalServiceWrapper

java.lang.Object

com.liferay.portal.service.PortletLocalServiceWrapper

All Implemented Interfaces:

BaseLocalService, PersistedModelLocalService, PortletLocalService, ServiceWrapper<PortletLocalService>

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

Provides a wrapper for PortletLocalService.

Author:

Brian Wing Shun Chan

See Also:

PortletLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
PortletLocalServiceWrapper(PortletLocalService portletLocalService)

Method Summary

Methods

Modifier and Type	Method and Description
Portlet	addPortlet(Portlet portlet) Adds the portlet to the database.
void	addPortletCategory(long companyId, java.lang.String categoryName)
void	checkPortlet(Portlet portlet)
void	checkPortlets(long companyId)
void	clearCache()
void	clearCompanyPortletsPool()
Portlet	clonePortlet(long companyId, java.lang.String portletId) Deprecated. As of 6.1.0, replaced by clonePortlet(String)
Portlet	clonePortlet(java.lang.String portletId)
Portlet	createPortlet(long id) Creates a new portlet with the primary key.
Portlet	deletePortlet(long id) Deletes the portlet with the primary key from the database.
void	deletePortlet(long companyId, java.lang.String portletId, long plid)
Portlet	deletePortlet(Portlet portlet) Deletes the portlet from the database.
void	deletePortlets(long companyId, java.lang.String[] portletIds, long plid)
Portlet	deployRemotePortlet(Portlet portlet, java.lang.String categoryName)
Portlet	deployRemotePortlet(Portlet portlet, java.lang.String[] categoryNames)
void	destroyPortlet(Portlet portlet)
void	destroyRemotePortlet(Portlet portlet)
DynamicQuery	dynamicQuery()
java.util.List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
Portlet	fetchPortlet(long id)
java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
java.util.List<CustomAttributesDisplay>	getCustomAttributesDisplays()
PortletCategory	getEARDisplay(java.lang.String xml)
java.util.List<Portlet>	getFriendlyURLMapperPortlets()
java.util.List<FriendlyURLMapper>	getFriendlyURLMappers()
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
Portlet	getPortlet(long id) Returns the portlet with the primary key.
PortletApp	getPortletApp(java.lang.String servletContextName)
Portlet	getPortletById(long companyId, java.lang.String portletId)
Portlet	getPortletById(java.lang.String portletId)
Portlet	getPortletByStrutsPath(long companyId, java.lang.String strutsPath)
java.util.List<Portlet>	getPortlets()
java.util.List<Portlet>	getPortlets(int start, int end) Returns a range of all the portlets.
java.util.List<Portlet>	getPortlets(long companyId)
java.util.List<Portlet>	getPortlets(long companyId, boolean showSystem, boolean showPortal)
int	getPortletsCount() Returns the number of portlets.
java.util.List<Portlet>	getScopablePortlets()
PortletCategory	getWARDisplay(java.lang.String servletContextName, java.lang.String xml)
PortletLocalService	getWrappedPortletLocalService() Deprecated. As of 6.1.0, replaced by getWrappedService()
PortletLocalService	getWrappedService()
boolean	hasPortlet(long companyId, java.lang.String portletId)
void	initEAR(javax.servlet.ServletContext servletContext, java.lang.String[] xmls, PluginPackage pluginPackage)
java.util.List<Portlet>	initWAR(java.lang.String servletContextName, javax.servlet.ServletContext servletContext, java.lang.String[] xmls, PluginPackage pluginPackage)
java.util.Map<java.lang.String,Portlet>	loadGetPortletsPool(long companyId)
void	removeCompanyPortletsPool(long companyId)
void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
void	setWrappedPortletLocalService(PortletLocalService portletLocalService) Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portal.service.PortletLocalService)
void	setWrappedService(PortletLocalService portletLocalService)
Portlet	updatePortlet(long companyId, java.lang.String portletId, java.lang.String roles, boolean active)
Portlet	updatePortlet(Portlet portlet) Updates the portlet in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.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)
                   throws SystemException

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

Throws:

SystemException - if a system exception occurred

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

deletePortlet

public Portlet deletePortlet(long id)
                      throws PortalException,
                             SystemException

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

SystemException - if a system exception occurred

deletePortlet

public Portlet deletePortlet(Portlet portlet)
                      throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public DynamicQuery dynamicQuery()

Specified by:

dynamicQuery in interface PortletLocalService

dynamicQuery

public java.util.List dynamicQuery(DynamicQuery dynamicQuery)
                            throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                          int start,
                          int end)
                            throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                          int start,
                          int end,
                          OrderByComparator orderByComparator)
                            throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Specified by:

dynamicQueryCount in interface PortletLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery,
                     Projection projection)
                       throws SystemException

Returns the number of rows that match 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 that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchPortlet

public Portlet fetchPortlet(long id)
                     throws SystemException

Specified by:

fetchPortlet in interface PortletLocalService

Throws:

SystemException

getPortlet

public Portlet getPortlet(long id)
                   throws PortalException,
                          SystemException

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

SystemException - if a system exception occurred

getPersistedModel

public PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Specified by:

getPersistedModel in interface PortletLocalService

Throws:

PortalException

SystemException

getPortlets

public java.util.List<Portlet> getPortlets(int start,
                                  int end)
                                    throws SystemException

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

Throws:

SystemException - if a system exception occurred

getPortletsCount

public int getPortletsCount()
                     throws SystemException

Returns the number of portlets.

Specified by:

getPortletsCount in interface PortletLocalService

Returns:

the number of portlets

Throws:

SystemException - if a system exception occurred

updatePortlet

public Portlet updatePortlet(Portlet portlet)
                      throws SystemException

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

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Specified by:

getBeanIdentifier in interface PortletLocalService

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Specified by:

setBeanIdentifier in interface PortletLocalService

Parameters:

beanIdentifier - the Spring bean ID for this bean

addPortletCategory

public void addPortletCategory(long companyId,
                      java.lang.String categoryName)

Specified by:

addPortletCategory in interface PortletLocalService

checkPortlet

public void checkPortlet(Portlet portlet)
                  throws PortalException,
                         SystemException

Specified by:

checkPortlet in interface PortletLocalService

Throws:

PortalException

SystemException

checkPortlets

public void checkPortlets(long companyId)
                   throws PortalException,
                          SystemException

Specified by:

checkPortlets in interface PortletLocalService

Throws:

PortalException

SystemException

clearCache

public void clearCache()

Specified by:

clearCache in interface PortletLocalService

clearCompanyPortletsPool

public void clearCompanyPortletsPool()

Specified by:

clearCompanyPortletsPool in interface PortletLocalService

clonePortlet

public Portlet clonePortlet(long companyId,
                   java.lang.String portletId)

Deprecated. As of 6.1.0, replaced by clonePortlet(String)

Specified by:

clonePortlet in interface PortletLocalService

clonePortlet

public Portlet clonePortlet(java.lang.String portletId)

Specified by:

clonePortlet in interface PortletLocalService

deletePortlet

public void deletePortlet(long companyId,
                 java.lang.String portletId,
                 long plid)
                   throws PortalException,
                          SystemException

Specified by:

deletePortlet in interface PortletLocalService

Throws:

PortalException

SystemException

deletePortlets

public void deletePortlets(long companyId,
                  java.lang.String[] portletIds,
                  long plid)
                    throws PortalException,
                           SystemException

Specified by:

deletePortlets in interface PortletLocalService

Throws:

PortalException

SystemException

deployRemotePortlet

public Portlet deployRemotePortlet(Portlet portlet,
                          java.lang.String categoryName)
                            throws PortalException,
                                   SystemException

Specified by:

deployRemotePortlet in interface PortletLocalService

Throws:

PortalException

SystemException

deployRemotePortlet

public Portlet deployRemotePortlet(Portlet portlet,
                          java.lang.String[] categoryNames)
                            throws PortalException,
                                   SystemException

Specified by:

deployRemotePortlet in interface PortletLocalService

Throws:

PortalException

SystemException

destroyPortlet

public void destroyPortlet(Portlet portlet)

Specified by:

destroyPortlet in interface PortletLocalService

destroyRemotePortlet

public void destroyRemotePortlet(Portlet portlet)

Specified by:

destroyRemotePortlet in interface PortletLocalService

getCustomAttributesDisplays

public java.util.List<CustomAttributesDisplay> getCustomAttributesDisplays()

Specified by:

getCustomAttributesDisplays in interface PortletLocalService

getEARDisplay

public PortletCategory getEARDisplay(java.lang.String xml)
                              throws SystemException

Specified by:

getEARDisplay in interface PortletLocalService

Throws:

SystemException

getFriendlyURLMapperPortlets

public java.util.List<Portlet> getFriendlyURLMapperPortlets()

Specified by:

getFriendlyURLMapperPortlets in interface PortletLocalService

getFriendlyURLMappers

public java.util.List<FriendlyURLMapper> getFriendlyURLMappers()

Specified by:

getFriendlyURLMappers in interface PortletLocalService

getPortletApp

public PortletApp getPortletApp(java.lang.String servletContextName)

Specified by:

getPortletApp in interface PortletLocalService

getPortletById

public Portlet getPortletById(long companyId,
                     java.lang.String portletId)
                       throws SystemException

Specified by:

getPortletById in interface PortletLocalService

Throws:

SystemException

getPortletById

public Portlet getPortletById(java.lang.String portletId)

Specified by:

getPortletById in interface PortletLocalService

getPortletByStrutsPath

public Portlet getPortletByStrutsPath(long companyId,
                             java.lang.String strutsPath)
                               throws SystemException

Specified by:

getPortletByStrutsPath in interface PortletLocalService

Throws:

SystemException

getPortlets

public java.util.List<Portlet> getPortlets()

Specified by:

getPortlets in interface PortletLocalService

getPortlets

public java.util.List<Portlet> getPortlets(long companyId)
                                    throws SystemException

Specified by:

getPortlets in interface PortletLocalService

Throws:

SystemException

getPortlets

public java.util.List<Portlet> getPortlets(long companyId,
                                  boolean showSystem,
                                  boolean showPortal)
                                    throws SystemException

Specified by:

getPortlets in interface PortletLocalService

Throws:

SystemException

getScopablePortlets

public java.util.List<Portlet> getScopablePortlets()

Specified by:

getScopablePortlets in interface PortletLocalService

getWARDisplay

public PortletCategory getWARDisplay(java.lang.String servletContextName,
                            java.lang.String xml)
                              throws SystemException

Specified by:

getWARDisplay in interface PortletLocalService

Throws:

SystemException

hasPortlet

public boolean hasPortlet(long companyId,
                 java.lang.String portletId)
                   throws SystemException

Specified by:

hasPortlet in interface PortletLocalService

Throws:

SystemException

initEAR

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

Specified by:

initEAR in interface PortletLocalService

initWAR

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

Specified by:

initWAR in interface PortletLocalService

loadGetPortletsPool

public java.util.Map<java.lang.String,Portlet> loadGetPortletsPool(long companyId)
                                                            throws SystemException

Specified by:

loadGetPortletsPool in interface PortletLocalService

Throws:

SystemException

removeCompanyPortletsPool

public void removeCompanyPortletsPool(long companyId)

Specified by:

removeCompanyPortletsPool in interface PortletLocalService

updatePortlet

public Portlet updatePortlet(long companyId,
                    java.lang.String portletId,
                    java.lang.String roles,
                    boolean active)
                      throws SystemException

Specified by:

updatePortlet in interface PortletLocalService

Throws:

SystemException

getWrappedPortletLocalService

public PortletLocalService getWrappedPortletLocalService()

Deprecated. As of 6.1.0, replaced by getWrappedService()

setWrappedPortletLocalService

public void setWrappedPortletLocalService(PortletLocalService portletLocalService)

Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portal.service.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>