/** * Copyright (c) 2000-present Liferay, Inc. All rights reserved. * * This library is free software; you can redistribute it and/or modify it under * the terms of the GNU Lesser General Public License as published by the Free * Software Foundation; either version 2.1 of the License, or (at your option) * any later version. * * This library is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more * details. */ package com.liferay.portal.service.base; import aQute.bnd.annotation.ProviderType; import com.liferay.portal.kernel.bean.BeanReference; import com.liferay.portal.kernel.dao.db.DB; import com.liferay.portal.kernel.dao.db.DBManagerUtil; import com.liferay.portal.kernel.dao.jdbc.SqlUpdate; import com.liferay.portal.kernel.dao.jdbc.SqlUpdateFactoryUtil; import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery; import com.liferay.portal.kernel.dao.orm.DefaultActionableDynamicQuery; import com.liferay.portal.kernel.dao.orm.DynamicQuery; import com.liferay.portal.kernel.dao.orm.DynamicQueryFactoryUtil; import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery; import com.liferay.portal.kernel.dao.orm.Projection; import com.liferay.portal.kernel.exception.PortalException; import com.liferay.portal.kernel.exception.SystemException; import com.liferay.portal.kernel.model.PersistedModel; import com.liferay.portal.kernel.model.Portlet; import com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService; import com.liferay.portal.kernel.search.Indexable; import com.liferay.portal.kernel.search.IndexableType; import com.liferay.portal.kernel.service.BaseLocalServiceImpl; import com.liferay.portal.kernel.service.PersistedModelLocalServiceRegistry; import com.liferay.portal.kernel.service.PortletLocalService; import com.liferay.portal.kernel.service.persistence.PortletPersistence; import com.liferay.portal.kernel.service.persistence.PortletPreferencesFinder; import com.liferay.portal.kernel.service.persistence.PortletPreferencesPersistence; import com.liferay.portal.kernel.service.persistence.ResourceActionPersistence; import com.liferay.portal.kernel.service.persistence.ResourceBlockFinder; import com.liferay.portal.kernel.service.persistence.ResourceBlockPersistence; import com.liferay.portal.kernel.service.persistence.ResourcePermissionFinder; import com.liferay.portal.kernel.service.persistence.ResourcePermissionPersistence; import com.liferay.portal.kernel.service.persistence.RoleFinder; import com.liferay.portal.kernel.service.persistence.RolePersistence; import com.liferay.portal.kernel.util.OrderByComparator; import com.liferay.portal.kernel.util.PortalUtil; import java.io.Serializable; import java.util.List; import javax.sql.DataSource; /** * Provides the base implementation for the portlet local service. * * <p> * This implementation exists only as a container for the default service methods generated by ServiceBuilder. All custom service methods should be put in {@link com.liferay.portal.service.impl.PortletLocalServiceImpl}. * </p> * * @author Brian Wing Shun Chan * @see com.liferay.portal.service.impl.PortletLocalServiceImpl * @see com.liferay.portal.kernel.service.PortletLocalServiceUtil * @generated */ @ProviderType public abstract class PortletLocalServiceBaseImpl extends BaseLocalServiceImpl implements PortletLocalService, IdentifiableOSGiService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this class directly. Always use {@link com.liferay.portal.kernel.service.PortletLocalServiceUtil} to access the portlet local service. */ /** * Adds the portlet to the database. Also notifies the appropriate model listeners. * * @param portlet the portlet * @return the portlet that was added */ @Indexable(type = IndexableType.REINDEX) @Override public Portlet addPortlet(Portlet portlet) { portlet.setNew(true); return portletPersistence.update(portlet); } /** * Creates a new portlet with the primary key. Does not add the portlet to the database. * * @param id the primary key for the new portlet * @return the new portlet */ @Override public Portlet createPortlet(long id) { return portletPersistence.create(id); } /** * Deletes the portlet with the primary key from the database. Also notifies the appropriate model listeners. * * @param id the primary key of the portlet * @return the portlet that was removed * @throws PortalException if a portlet with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) @Override public Portlet deletePortlet(long id) throws PortalException { return portletPersistence.remove(id); } /** * Deletes the portlet from the database. Also notifies the appropriate model listeners. * * @param portlet the portlet * @return the portlet that was removed */ @Indexable(type = IndexableType.DELETE) @Override public Portlet deletePortlet(Portlet portlet) { return portletPersistence.remove(portlet); } @Override public DynamicQuery dynamicQuery() { Class<?> clazz = getClass(); return DynamicQueryFactoryUtil.forClass(Portlet.class, clazz.getClassLoader()); } /** * Performs a dynamic query on the database and returns the matching rows. * * @param dynamicQuery the dynamic query * @return the matching rows */ @Override public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery) { return portletPersistence.findWithDynamicQuery(dynamicQuery); } /** * Performs a dynamic query on the database and returns a range of the matching rows. * * <p> * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.PortletModelImpl}. If both <code>orderByComparator</code> 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. * </p> * * @param dynamicQuery the dynamic query * @param start the lower bound of the range of model instances * @param end the upper bound of the range of model instances (not inclusive) * @return the range of matching rows */ @Override public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end) { return portletPersistence.findWithDynamicQuery(dynamicQuery, start, end); } /** * Performs a dynamic query on the database and returns an ordered range of the matching rows. * * <p> * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.PortletModelImpl}. If both <code>orderByComparator</code> 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. * </p> * * @param dynamicQuery the dynamic query * @param start the lower bound of the range of model instances * @param end the upper bound of the range of model instances (not inclusive) * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) * @return the ordered range of matching rows */ @Override public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) { return portletPersistence.findWithDynamicQuery(dynamicQuery, start, end, orderByComparator); } /** * Returns the number of rows matching the dynamic query. * * @param dynamicQuery the dynamic query * @return the number of rows matching the dynamic query */ @Override public long dynamicQueryCount(DynamicQuery dynamicQuery) { return portletPersistence.countWithDynamicQuery(dynamicQuery); } /** * Returns the number of rows matching the dynamic query. * * @param dynamicQuery the dynamic query * @param projection the projection to apply to the query * @return the number of rows matching the dynamic query */ @Override public long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) { return portletPersistence.countWithDynamicQuery(dynamicQuery, projection); } @Override public Portlet fetchPortlet(long id) { return portletPersistence.fetchByPrimaryKey(id); } /** * Returns the portlet with the primary key. * * @param id the primary key of the portlet * @return the portlet * @throws PortalException if a portlet with the primary key could not be found */ @Override public Portlet getPortlet(long id) throws PortalException { return portletPersistence.findByPrimaryKey(id); } @Override public ActionableDynamicQuery getActionableDynamicQuery() { ActionableDynamicQuery actionableDynamicQuery = new DefaultActionableDynamicQuery(); actionableDynamicQuery.setBaseLocalService(portletLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(Portlet.class); actionableDynamicQuery.setPrimaryKeyPropertyName("id"); return actionableDynamicQuery; } @Override public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { IndexableActionableDynamicQuery indexableActionableDynamicQuery = new IndexableActionableDynamicQuery(); indexableActionableDynamicQuery.setBaseLocalService(portletLocalService); indexableActionableDynamicQuery.setClassLoader(getClassLoader()); indexableActionableDynamicQuery.setModelClass(Portlet.class); indexableActionableDynamicQuery.setPrimaryKeyPropertyName("id"); return indexableActionableDynamicQuery; } protected void initActionableDynamicQuery( ActionableDynamicQuery actionableDynamicQuery) { actionableDynamicQuery.setBaseLocalService(portletLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(Portlet.class); actionableDynamicQuery.setPrimaryKeyPropertyName("id"); } /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException { return portletLocalService.deletePortlet((Portlet)persistedModel); } @Override public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException { return portletPersistence.findByPrimaryKey(primaryKeyObj); } /** * Returns a range of all the portlets. * * <p> * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.PortletModelImpl}. If both <code>orderByComparator</code> 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. * </p> * * @param start the lower bound of the range of portlets * @param end the upper bound of the range of portlets (not inclusive) * @return the range of portlets */ @Override public List<Portlet> getPortlets(int start, int end) { return portletPersistence.findAll(start, end); } /** * Returns the number of portlets. * * @return the number of portlets */ @Override public int getPortletsCount() { return portletPersistence.countAll(); } /** * Updates the portlet in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param portlet the portlet * @return the portlet that was updated */ @Indexable(type = IndexableType.REINDEX) @Override public Portlet updatePortlet(Portlet portlet) { return portletPersistence.update(portlet); } /** * Returns the portlet local service. * * @return the portlet local service */ public PortletLocalService getPortletLocalService() { return portletLocalService; } /** * Sets the portlet local service. * * @param portletLocalService the portlet local service */ public void setPortletLocalService(PortletLocalService portletLocalService) { this.portletLocalService = portletLocalService; } /** * Returns the portlet persistence. * * @return the portlet persistence */ public PortletPersistence getPortletPersistence() { return portletPersistence; } /** * Sets the portlet persistence. * * @param portletPersistence the portlet persistence */ public void setPortletPersistence(PortletPersistence portletPersistence) { this.portletPersistence = portletPersistence; } /** * Returns the counter local service. * * @return the counter local service */ public com.liferay.counter.kernel.service.CounterLocalService getCounterLocalService() { return counterLocalService; } /** * Sets the counter local service. * * @param counterLocalService the counter local service */ public void setCounterLocalService( com.liferay.counter.kernel.service.CounterLocalService counterLocalService) { this.counterLocalService = counterLocalService; } /** * Returns the portlet preferences local service. * * @return the portlet preferences local service */ public com.liferay.portal.kernel.service.PortletPreferencesLocalService getPortletPreferencesLocalService() { return portletPreferencesLocalService; } /** * Sets the portlet preferences local service. * * @param portletPreferencesLocalService the portlet preferences local service */ public void setPortletPreferencesLocalService( com.liferay.portal.kernel.service.PortletPreferencesLocalService portletPreferencesLocalService) { this.portletPreferencesLocalService = portletPreferencesLocalService; } /** * Returns the portlet preferences persistence. * * @return the portlet preferences persistence */ public PortletPreferencesPersistence getPortletPreferencesPersistence() { return portletPreferencesPersistence; } /** * Sets the portlet preferences persistence. * * @param portletPreferencesPersistence the portlet preferences persistence */ public void setPortletPreferencesPersistence( PortletPreferencesPersistence portletPreferencesPersistence) { this.portletPreferencesPersistence = portletPreferencesPersistence; } /** * Returns the portlet preferences finder. * * @return the portlet preferences finder */ public PortletPreferencesFinder getPortletPreferencesFinder() { return portletPreferencesFinder; } /** * Sets the portlet preferences finder. * * @param portletPreferencesFinder the portlet preferences finder */ public void setPortletPreferencesFinder( PortletPreferencesFinder portletPreferencesFinder) { this.portletPreferencesFinder = portletPreferencesFinder; } /** * Returns the resource local service. * * @return the resource local service */ public com.liferay.portal.kernel.service.ResourceLocalService getResourceLocalService() { return resourceLocalService; } /** * Sets the resource local service. * * @param resourceLocalService the resource local service */ public void setResourceLocalService( com.liferay.portal.kernel.service.ResourceLocalService resourceLocalService) { this.resourceLocalService = resourceLocalService; } /** * Returns the resource action local service. * * @return the resource action local service */ public com.liferay.portal.kernel.service.ResourceActionLocalService getResourceActionLocalService() { return resourceActionLocalService; } /** * Sets the resource action local service. * * @param resourceActionLocalService the resource action local service */ public void setResourceActionLocalService( com.liferay.portal.kernel.service.ResourceActionLocalService resourceActionLocalService) { this.resourceActionLocalService = resourceActionLocalService; } /** * Returns the resource action persistence. * * @return the resource action persistence */ public ResourceActionPersistence getResourceActionPersistence() { return resourceActionPersistence; } /** * Sets the resource action persistence. * * @param resourceActionPersistence the resource action persistence */ public void setResourceActionPersistence( ResourceActionPersistence resourceActionPersistence) { this.resourceActionPersistence = resourceActionPersistence; } /** * Returns the resource block local service. * * @return the resource block local service */ public com.liferay.portal.kernel.service.ResourceBlockLocalService getResourceBlockLocalService() { return resourceBlockLocalService; } /** * Sets the resource block local service. * * @param resourceBlockLocalService the resource block local service */ public void setResourceBlockLocalService( com.liferay.portal.kernel.service.ResourceBlockLocalService resourceBlockLocalService) { this.resourceBlockLocalService = resourceBlockLocalService; } /** * Returns the resource block persistence. * * @return the resource block persistence */ public ResourceBlockPersistence getResourceBlockPersistence() { return resourceBlockPersistence; } /** * Sets the resource block persistence. * * @param resourceBlockPersistence the resource block persistence */ public void setResourceBlockPersistence( ResourceBlockPersistence resourceBlockPersistence) { this.resourceBlockPersistence = resourceBlockPersistence; } /** * Returns the resource block finder. * * @return the resource block finder */ public ResourceBlockFinder getResourceBlockFinder() { return resourceBlockFinder; } /** * Sets the resource block finder. * * @param resourceBlockFinder the resource block finder */ public void setResourceBlockFinder(ResourceBlockFinder resourceBlockFinder) { this.resourceBlockFinder = resourceBlockFinder; } /** * Returns the resource permission local service. * * @return the resource permission local service */ public com.liferay.portal.kernel.service.ResourcePermissionLocalService getResourcePermissionLocalService() { return resourcePermissionLocalService; } /** * Sets the resource permission local service. * * @param resourcePermissionLocalService the resource permission local service */ public void setResourcePermissionLocalService( com.liferay.portal.kernel.service.ResourcePermissionLocalService resourcePermissionLocalService) { this.resourcePermissionLocalService = resourcePermissionLocalService; } /** * Returns the resource permission persistence. * * @return the resource permission persistence */ public ResourcePermissionPersistence getResourcePermissionPersistence() { return resourcePermissionPersistence; } /** * Sets the resource permission persistence. * * @param resourcePermissionPersistence the resource permission persistence */ public void setResourcePermissionPersistence( ResourcePermissionPersistence resourcePermissionPersistence) { this.resourcePermissionPersistence = resourcePermissionPersistence; } /** * Returns the resource permission finder. * * @return the resource permission finder */ public ResourcePermissionFinder getResourcePermissionFinder() { return resourcePermissionFinder; } /** * Sets the resource permission finder. * * @param resourcePermissionFinder the resource permission finder */ public void setResourcePermissionFinder( ResourcePermissionFinder resourcePermissionFinder) { this.resourcePermissionFinder = resourcePermissionFinder; } /** * Returns the role local service. * * @return the role local service */ public com.liferay.portal.kernel.service.RoleLocalService getRoleLocalService() { return roleLocalService; } /** * Sets the role local service. * * @param roleLocalService the role local service */ public void setRoleLocalService( com.liferay.portal.kernel.service.RoleLocalService roleLocalService) { this.roleLocalService = roleLocalService; } /** * Returns the role persistence. * * @return the role persistence */ public RolePersistence getRolePersistence() { return rolePersistence; } /** * Sets the role persistence. * * @param rolePersistence the role persistence */ public void setRolePersistence(RolePersistence rolePersistence) { this.rolePersistence = rolePersistence; } /** * Returns the role finder. * * @return the role finder */ public RoleFinder getRoleFinder() { return roleFinder; } /** * Sets the role finder. * * @param roleFinder the role finder */ public void setRoleFinder(RoleFinder roleFinder) { this.roleFinder = roleFinder; } public void afterPropertiesSet() { persistedModelLocalServiceRegistry.register("com.liferay.portal.kernel.model.Portlet", portletLocalService); } public void destroy() { persistedModelLocalServiceRegistry.unregister( "com.liferay.portal.kernel.model.Portlet"); } /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ @Override public String getOSGiServiceIdentifier() { return PortletLocalService.class.getName(); } protected Class<?> getModelClass() { return Portlet.class; } protected String getModelClassName() { return Portlet.class.getName(); } /** * Performs a SQL query. * * @param sql the sql query */ protected void runSQL(String sql) { try { DataSource dataSource = portletPersistence.getDataSource(); DB db = DBManagerUtil.getDB(); sql = db.buildSQL(sql); sql = PortalUtil.transformSQL(sql); SqlUpdate sqlUpdate = SqlUpdateFactoryUtil.getSqlUpdate(dataSource, sql); sqlUpdate.update(); } catch (Exception e) { throw new SystemException(e); } } @BeanReference(type = PortletLocalService.class) protected PortletLocalService portletLocalService; @BeanReference(type = PortletPersistence.class) protected PortletPersistence portletPersistence; @BeanReference(type = com.liferay.counter.kernel.service.CounterLocalService.class) protected com.liferay.counter.kernel.service.CounterLocalService counterLocalService; @BeanReference(type = com.liferay.portal.kernel.service.PortletPreferencesLocalService.class) protected com.liferay.portal.kernel.service.PortletPreferencesLocalService portletPreferencesLocalService; @BeanReference(type = PortletPreferencesPersistence.class) protected PortletPreferencesPersistence portletPreferencesPersistence; @BeanReference(type = PortletPreferencesFinder.class) protected PortletPreferencesFinder portletPreferencesFinder; @BeanReference(type = com.liferay.portal.kernel.service.ResourceLocalService.class) protected com.liferay.portal.kernel.service.ResourceLocalService resourceLocalService; @BeanReference(type = com.liferay.portal.kernel.service.ResourceActionLocalService.class) protected com.liferay.portal.kernel.service.ResourceActionLocalService resourceActionLocalService; @BeanReference(type = ResourceActionPersistence.class) protected ResourceActionPersistence resourceActionPersistence; @BeanReference(type = com.liferay.portal.kernel.service.ResourceBlockLocalService.class) protected com.liferay.portal.kernel.service.ResourceBlockLocalService resourceBlockLocalService; @BeanReference(type = ResourceBlockPersistence.class) protected ResourceBlockPersistence resourceBlockPersistence; @BeanReference(type = ResourceBlockFinder.class) protected ResourceBlockFinder resourceBlockFinder; @BeanReference(type = com.liferay.portal.kernel.service.ResourcePermissionLocalService.class) protected com.liferay.portal.kernel.service.ResourcePermissionLocalService resourcePermissionLocalService; @BeanReference(type = ResourcePermissionPersistence.class) protected ResourcePermissionPersistence resourcePermissionPersistence; @BeanReference(type = ResourcePermissionFinder.class) protected ResourcePermissionFinder resourcePermissionFinder; @BeanReference(type = com.liferay.portal.kernel.service.RoleLocalService.class) protected com.liferay.portal.kernel.service.RoleLocalService roleLocalService; @BeanReference(type = RolePersistence.class) protected RolePersistence rolePersistence; @BeanReference(type = RoleFinder.class) protected RoleFinder roleFinder; @BeanReference(type = PersistedModelLocalServiceRegistry.class) protected PersistedModelLocalServiceRegistry persistedModelLocalServiceRegistry; }