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.voidaddPortletCategory(long companyId, String categoryName) voidcheckPortlet(Portlet portlet) voidcheckPortlets(long companyId) voidvoidclonePortlet(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.voiddeletePortlet(long companyId, String portletId, long plid) deletePortlet(Portlet portlet) Deletes the portlet from the database.voiddeletePortlets(long companyId, String[] portletIds, long plid) voiddeployPortlet(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) voiddestroyPortlet(Portlet portlet) voiddestroyRemotePortlet(Portlet portlet) <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(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.longdynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.longdynamicQueryCount(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) intReturns the number of portlets.intgetPortletsCount(long companyId) getWARDisplay(String servletContextName, String xml) booleanhasPortlet(long companyId, String portletId) voidinitEAR(javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage) initWAR(String servletContextName, javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage) loadGetPortletsMap(long companyId) voidremoveCompanyPortletsPool(long companyId) voidsetWrappedService(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.voidvisitPortlets(long companyId, Consumer<Portlet> consumer) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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:
addPortletin interfacePortletLocalService- Parameters:
portlet- the portlet- Returns:
- the portlet that was added
-
addPortletCategory
- Specified by:
addPortletCategoryin interfacePortletLocalService
-
checkPortlet
- Specified by:
checkPortletin interfacePortletLocalService- Throws:
PortalException
-
checkPortlets
- Specified by:
checkPortletsin interfacePortletLocalService- Throws:
PortalException
-
clearCache
public void clearCache()- Specified by:
clearCachein interfacePortletLocalService
-
clearPortletsMap
public void clearPortletsMap()- Specified by:
clearPortletsMapin interfacePortletLocalService
-
clonePortlet
- Specified by:
clonePortletin interfacePortletLocalService
-
createPersistedModel
- Specified by:
createPersistedModelin interfacePersistedModelLocalService- Specified by:
createPersistedModelin interfacePortletLocalService- Throws:
PortalExceptionPortalException
-
createPortlet
Creates a new portlet with the primary key. Does not add the portlet to the database.- Specified by:
createPortletin interfacePortletLocalService- Parameters:
id- the primary key for the new portlet- Returns:
- the new portlet
-
deletePersistedModel
- Specified by:
deletePersistedModelin interfacePersistedModelLocalService- Specified by:
deletePersistedModelin interfacePortletLocalService- Throws:
PortalExceptionPortalException
-
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:
deletePortletin 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:
deletePortletin 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:
deletePortletin interfacePortletLocalService- Parameters:
portlet- the portlet- Returns:
- the portlet that was removed
-
deletePortlets
- Specified by:
deletePortletsin interfacePortletLocalService- Throws:
PortalException
-
deployPortlet
- Specified by:
deployPortletin interfacePortletLocalService- Throws:
Exception
-
deployRemotePortlet
public Portlet deployRemotePortlet(long[] companyIds, Portlet portlet, String[] categoryNames, boolean eagerDestroy, boolean clearCache) throws PortalException - Specified by:
deployRemotePortletin interfacePortletLocalService- Throws:
PortalException
-
deployRemotePortlet
- Specified by:
deployRemotePortletin interfacePortletLocalService- Throws:
PortalException
-
deployRemotePortlet
- Specified by:
deployRemotePortletin interfacePortletLocalService- Throws:
PortalException
-
deployRemotePortlet
public Portlet deployRemotePortlet(Portlet portlet, String[] categoryNames, boolean eagerDestroy) throws PortalException - Specified by:
deployRemotePortletin interfacePortletLocalService- Throws:
PortalException
-
destroyPortlet
- Specified by:
destroyPortletin interfacePortletLocalService
-
destroyRemotePortlet
- Specified by:
destroyRemotePortletin interfacePortletLocalService
-
dslQuery
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryin interfacePersistedModelLocalService- Specified by:
dslQueryin interfacePortletLocalService
-
dslQueryCount
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfacePersistedModelLocalService- Specified by:
dslQueryCountin interfacePortletLocalService
-
dynamicQuery
- Specified by:
dynamicQueryin interfacePortletLocalService
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Specified by:
dynamicQueryin 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PortletModelImpl.- Specified by:
dynamicQueryin 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PortletModelImpl.- Specified by:
dynamicQueryin 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:
dynamicQueryCountin 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:
dynamicQueryCountin 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:
fetchPortletin interfacePortletLocalService
-
fetchPortletById
- Specified by:
fetchPortletByIdin interfacePortletLocalService
-
getActionableDynamicQuery
- Specified by:
getActionableDynamicQueryin interfacePortletLocalService
-
getCustomAttributesDisplays
- Specified by:
getCustomAttributesDisplaysin interfacePortletLocalService
-
getEARDisplay
- Specified by:
getEARDisplayin interfacePortletLocalService
-
getFriendlyURLMapperPortlets
- Specified by:
getFriendlyURLMapperPortletsin interfacePortletLocalService
-
getFriendlyURLMappers
- Specified by:
getFriendlyURLMappersin interfacePortletLocalService
-
getIndexableActionableDynamicQuery
- Specified by:
getIndexableActionableDynamicQueryin interfacePortletLocalService
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifierin interfacePortletLocalService- Returns:
- the OSGi service identifier
-
getPersistedModel
- Specified by:
getPersistedModelin interfacePersistedModelLocalService- Specified by:
getPersistedModelin interfacePortletLocalService- Throws:
PortalExceptionPortalException
-
getPortlet
Returns the portlet with the primary key.- Specified by:
getPortletin 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:
getPortletAppin interfacePortletLocalService
-
getPortletById
- Specified by:
getPortletByIdin interfacePortletLocalService
-
getPortletById
- Specified by:
getPortletByIdin interfacePortletLocalService
-
getPortletByStrutsPath
- Specified by:
getPortletByStrutsPathin interfacePortletLocalService
-
getPortletFriendlyURLMapperMatch
- Specified by:
getPortletFriendlyURLMapperMatchin interfacePortletLocalService
-
getPortlets
- Specified by:
getPortletsin interfacePortletLocalService
-
getPortlets
Returns a range of all the portlets.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PortletModelImpl.- Specified by:
getPortletsin 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:
getPortletsin interfacePortletLocalService
-
getPortlets
- Specified by:
getPortletsin interfacePortletLocalService
-
getPortletsCount
public int getPortletsCount()Returns the number of portlets.- Specified by:
getPortletsCountin interfacePortletLocalService- Returns:
- the number of portlets
-
getPortletsCount
public int getPortletsCount(long companyId) - Specified by:
getPortletsCountin interfacePortletLocalService
-
getScopablePortlets
- Specified by:
getScopablePortletsin interfacePortletLocalService
-
getWARDisplay
- Specified by:
getWARDisplayin interfacePortletLocalService
-
hasPortlet
- Specified by:
hasPortletin interfacePortletLocalService
-
initEAR
public void initEAR(javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage) - Specified by:
initEARin interfacePortletLocalService
-
initWAR
public List<Portlet> initWAR(String servletContextName, javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage) - Specified by:
initWARin interfacePortletLocalService
-
loadGetPortletsMap
- Specified by:
loadGetPortletsMapin interfacePortletLocalService
-
removeCompanyPortletsPool
public void removeCompanyPortletsPool(long companyId) - Specified by:
removeCompanyPortletsPoolin interfacePortletLocalService
-
updatePortlet
- Specified by:
updatePortletin 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:
updatePortletin interfacePortletLocalService- Parameters:
portlet- the portlet- Returns:
- the portlet that was updated
-
visitPortlets
- Specified by:
visitPortletsin interfacePortletLocalService
-
getBasePersistence
- Specified by:
getBasePersistencein interfacePersistedModelLocalService
-
getWrappedService
- Specified by:
getWrappedServicein interfaceServiceWrapper<PortletLocalService>
-
setWrappedService
- Specified by:
setWrappedServicein interfaceServiceWrapper<PortletLocalService>
-