Class PortletLocalServiceWrapper
- All Implemented Interfaces:
BaseLocalService
,PersistedModelLocalService
,PortletLocalService
,ServiceWrapper<PortletLocalService>
PortletLocalService
.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddPortlet
(Portlet portlet) Adds the portlet to the database.void
addPortletCategory
(long companyId, String categoryName) void
checkPortlet
(Portlet portlet) void
checkPortlets
(long companyId) void
void
clonePortlet
(String portletId) createPersistedModel
(Serializable primaryKeyObj) createPortlet
(long id) Creates a new portlet with the primary key.deletePersistedModel
(PersistedModel persistedModel) deletePortlet
(long id) Deletes the portlet with the primary key from the database.void
deletePortlet
(long companyId, String portletId, long plid) deletePortlet
(Portlet portlet) Deletes the portlet from the database.void
deletePortlets
(long companyId, String[] portletIds, long plid) void
deployPortlet
(Portlet portlet) deployRemotePortlet
(long[] companyIds, Portlet portlet, String[] categoryNames, boolean eagerDestroy, boolean clearCache) deployRemotePortlet
(Portlet portlet, String categoryName) deployRemotePortlet
(Portlet portlet, String[] categoryNames) deployRemotePortlet
(Portlet portlet, String[] categoryNames, boolean eagerDestroy) void
destroyPortlet
(Portlet portlet) void
destroyRemotePortlet
(Portlet portlet) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <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.fetchPortlet
(long id) fetchPortletById
(long companyId, String portletId) getEARDisplay
(String xml) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getPortlet
(long id) Returns the portlet with the primary key.getPortletApp
(String servletContextName) getPortletById
(long companyId, String portletId) getPortletById
(String portletId) getPortletByStrutsPath
(long companyId, String strutsPath) getPortlets
(int start, int end) Returns a range of all the portlets.getPortlets
(long companyId) getPortlets
(long companyId, boolean showSystem, boolean showPortal) int
Returns the number of portlets.int
getPortletsCount
(long companyId) getWARDisplay
(String servletContextName, String xml) boolean
hasPortlet
(long companyId, String portletId) void
initEAR
(javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage) initWAR
(String servletContextName, javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage) loadGetPortletsMap
(long companyId) void
removeCompanyPortletsPool
(long companyId) void
setWrappedService
(PortletLocalService portletLocalService) updatePortlet
(long companyId, String portletId, String roles, boolean active) 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel
-
Constructor Details
-
PortletLocalServiceWrapper
public PortletLocalServiceWrapper() -
PortletLocalServiceWrapper
-
-
Method Details
-
addPortlet
Adds the portlet to the database. Also notifies the appropriate model listeners.Important: Inspect PortletLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Specified by:
addPortlet
in interfacePortletLocalService
- Parameters:
portlet
- the portlet- Returns:
- the portlet that was added
-
addPortletCategory
- Specified by:
addPortletCategory
in interfacePortletLocalService
-
checkPortlet
- Specified by:
checkPortlet
in interfacePortletLocalService
- Throws:
PortalException
-
checkPortlets
- Specified by:
checkPortlets
in interfacePortletLocalService
- Throws:
PortalException
-
clearCache
public void clearCache()- Specified by:
clearCache
in interfacePortletLocalService
-
clearPortletsMap
public void clearPortletsMap()- Specified by:
clearPortletsMap
in interfacePortletLocalService
-
clonePortlet
- Specified by:
clonePortlet
in interfacePortletLocalService
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Specified by:
createPersistedModel
in interfacePortletLocalService
- Throws:
PortalException
PortalException
-
createPortlet
Creates a new portlet with the primary key. Does not add the portlet to the database.- Specified by:
createPortlet
in interfacePortletLocalService
- Parameters:
id
- the primary key for the new portlet- Returns:
- the new portlet
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Specified by:
deletePersistedModel
in interfacePortletLocalService
- Throws:
PortalException
PortalException
-
deletePortlet
Deletes the portlet with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect PortletLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Specified by:
deletePortlet
in interfacePortletLocalService
- 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 foundPortalException
-
deletePortlet
- Specified by:
deletePortlet
in interfacePortletLocalService
- Throws:
PortalException
-
deletePortlet
Deletes the portlet from the database. Also notifies the appropriate model listeners.Important: Inspect PortletLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Specified by:
deletePortlet
in interfacePortletLocalService
- Parameters:
portlet
- the portlet- Returns:
- the portlet that was removed
-
deletePortlets
- Specified by:
deletePortlets
in interfacePortletLocalService
- Throws:
PortalException
-
deployPortlet
- Specified by:
deployPortlet
in interfacePortletLocalService
- Throws:
Exception
-
deployRemotePortlet
public Portlet deployRemotePortlet(long[] companyIds, Portlet portlet, String[] categoryNames, boolean eagerDestroy, boolean clearCache) throws PortalException - Specified by:
deployRemotePortlet
in interfacePortletLocalService
- Throws:
PortalException
-
deployRemotePortlet
- Specified by:
deployRemotePortlet
in interfacePortletLocalService
- Throws:
PortalException
-
deployRemotePortlet
- Specified by:
deployRemotePortlet
in interfacePortletLocalService
- Throws:
PortalException
-
deployRemotePortlet
public Portlet deployRemotePortlet(Portlet portlet, String[] categoryNames, boolean eagerDestroy) throws PortalException - Specified by:
deployRemotePortlet
in interfacePortletLocalService
- Throws:
PortalException
-
destroyPortlet
- Specified by:
destroyPortlet
in interfacePortletLocalService
-
destroyRemotePortlet
- Specified by:
destroyRemotePortlet
in interfacePortletLocalService
-
dslQuery
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
- Specified by:
dslQuery
in interfacePortletLocalService
-
dslQueryCount
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
- Specified by:
dslQueryCount
in interfacePortletLocalService
-
dynamicQuery
- Specified by:
dynamicQuery
in interfacePortletLocalService
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Specified by:
dynamicQuery
in interfacePortletLocalService
- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PortletModelImpl
.- Specified by:
dynamicQuery
in interfacePortletLocalService
- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PortletModelImpl
.- Specified by:
dynamicQuery
in interfacePortletLocalService
- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCount
in interfacePortletLocalService
- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCount
in interfacePortletLocalService
- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchPortlet
- Specified by:
fetchPortlet
in interfacePortletLocalService
-
fetchPortletById
- Specified by:
fetchPortletById
in interfacePortletLocalService
-
getActionableDynamicQuery
- Specified by:
getActionableDynamicQuery
in interfacePortletLocalService
-
getCustomAttributesDisplays
- Specified by:
getCustomAttributesDisplays
in interfacePortletLocalService
-
getEARDisplay
- Specified by:
getEARDisplay
in interfacePortletLocalService
-
getFriendlyURLMapperPortlets
- Specified by:
getFriendlyURLMapperPortlets
in interfacePortletLocalService
-
getFriendlyURLMappers
- Specified by:
getFriendlyURLMappers
in interfacePortletLocalService
-
getIndexableActionableDynamicQuery
- Specified by:
getIndexableActionableDynamicQuery
in interfacePortletLocalService
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifier
in interfacePortletLocalService
- Returns:
- the OSGi service identifier
-
getPersistedModel
- Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Specified by:
getPersistedModel
in interfacePortletLocalService
- Throws:
PortalException
PortalException
-
getPortlet
Returns the portlet with the primary key.- Specified by:
getPortlet
in interfacePortletLocalService
- Parameters:
id
- the primary key of the portlet- Returns:
- the portlet
- Throws:
PortalException
- if a portlet with the primary key could not be foundPortalException
-
getPortletApp
- Specified by:
getPortletApp
in interfacePortletLocalService
-
getPortletById
- Specified by:
getPortletById
in interfacePortletLocalService
-
getPortletById
- Specified by:
getPortletById
in interfacePortletLocalService
-
getPortletByStrutsPath
- Specified by:
getPortletByStrutsPath
in interfacePortletLocalService
-
getPortletFriendlyURLMapperMatch
- Specified by:
getPortletFriendlyURLMapperMatch
in interfacePortletLocalService
-
getPortlets
- Specified by:
getPortlets
in interfacePortletLocalService
-
getPortlets
Returns a range of all the portlets.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PortletModelImpl
.- Specified by:
getPortlets
in interfacePortletLocalService
- Parameters:
start
- the lower bound of the range of portletsend
- the upper bound of the range of portlets (not inclusive)- Returns:
- the range of portlets
-
getPortlets
- Specified by:
getPortlets
in interfacePortletLocalService
-
getPortlets
- Specified by:
getPortlets
in interfacePortletLocalService
-
getPortletsCount
public int getPortletsCount()Returns the number of portlets.- Specified by:
getPortletsCount
in interfacePortletLocalService
- Returns:
- the number of portlets
-
getPortletsCount
public int getPortletsCount(long companyId) - Specified by:
getPortletsCount
in interfacePortletLocalService
-
getScopablePortlets
- Specified by:
getScopablePortlets
in interfacePortletLocalService
-
getWARDisplay
- Specified by:
getWARDisplay
in interfacePortletLocalService
-
hasPortlet
- Specified by:
hasPortlet
in interfacePortletLocalService
-
initEAR
public void initEAR(javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage) - Specified by:
initEAR
in interfacePortletLocalService
-
initWAR
public List<Portlet> initWAR(String servletContextName, javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage) - Specified by:
initWAR
in interfacePortletLocalService
-
loadGetPortletsMap
- Specified by:
loadGetPortletsMap
in interfacePortletLocalService
-
removeCompanyPortletsPool
public void removeCompanyPortletsPool(long companyId) - Specified by:
removeCompanyPortletsPool
in interfacePortletLocalService
-
updatePortlet
- Specified by:
updatePortlet
in interfacePortletLocalService
-
updatePortlet
Updates the portlet in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect PortletLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Specified by:
updatePortlet
in interfacePortletLocalService
- Parameters:
portlet
- the portlet- Returns:
- the portlet that was updated
-
visitPortlets
- Specified by:
visitPortlets
in interfacePortletLocalService
-
getBasePersistence
- Specified by:
getBasePersistence
in interfacePersistedModelLocalService
-
getWrappedService
- Specified by:
getWrappedService
in interfaceServiceWrapper<PortletLocalService>
-
setWrappedService
- Specified by:
setWrappedService
in interfaceServiceWrapper<PortletLocalService>
-