/** * 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.PortletPreferences; 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.PortletPreferencesLocalService; import com.liferay.portal.kernel.service.persistence.LayoutFinder; import com.liferay.portal.kernel.service.persistence.LayoutPersistence; import com.liferay.portal.kernel.service.persistence.LayoutRevisionPersistence; import com.liferay.portal.kernel.service.persistence.PortletItemPersistence; 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.UserFinder; import com.liferay.portal.kernel.service.persistence.UserPersistence; 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 preferences 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.PortletPreferencesLocalServiceImpl}. * </p> * * @author Brian Wing Shun Chan * @see com.liferay.portal.service.impl.PortletPreferencesLocalServiceImpl * @see com.liferay.portal.kernel.service.PortletPreferencesLocalServiceUtil * @generated */ @ProviderType public abstract class PortletPreferencesLocalServiceBaseImpl extends BaseLocalServiceImpl implements PortletPreferencesLocalService, IdentifiableOSGiService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this class directly. Always use {@link com.liferay.portal.kernel.service.PortletPreferencesLocalServiceUtil} to access the portlet preferences local service. */ /** * Adds the portlet preferences to the database. Also notifies the appropriate model listeners. * * @param portletPreferences the portlet preferences * @return the portlet preferences that was added */ @Indexable(type = IndexableType.REINDEX) @Override public PortletPreferences addPortletPreferences( PortletPreferences portletPreferences) { portletPreferences.setNew(true); return portletPreferencesPersistence.update(portletPreferences); } /** * Creates a new portlet preferences with the primary key. Does not add the portlet preferences to the database. * * @param portletPreferencesId the primary key for the new portlet preferences * @return the new portlet preferences */ @Override public PortletPreferences createPortletPreferences( long portletPreferencesId) { return portletPreferencesPersistence.create(portletPreferencesId); } /** * Deletes the portlet preferences with the primary key from the database. Also notifies the appropriate model listeners. * * @param portletPreferencesId the primary key of the portlet preferences * @return the portlet preferences that was removed * @throws PortalException if a portlet preferences with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) @Override public PortletPreferences deletePortletPreferences( long portletPreferencesId) throws PortalException { return portletPreferencesPersistence.remove(portletPreferencesId); } /** * Deletes the portlet preferences from the database. Also notifies the appropriate model listeners. * * @param portletPreferences the portlet preferences * @return the portlet preferences that was removed */ @Indexable(type = IndexableType.DELETE) @Override public PortletPreferences deletePortletPreferences( PortletPreferences portletPreferences) { return portletPreferencesPersistence.remove(portletPreferences); } @Override public DynamicQuery dynamicQuery() { Class<?> clazz = getClass(); return DynamicQueryFactoryUtil.forClass(PortletPreferences.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 portletPreferencesPersistence.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.PortletPreferencesModelImpl}. 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 portletPreferencesPersistence.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.PortletPreferencesModelImpl}. 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 portletPreferencesPersistence.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 portletPreferencesPersistence.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 portletPreferencesPersistence.countWithDynamicQuery(dynamicQuery, projection); } @Override public PortletPreferences fetchPortletPreferences(long portletPreferencesId) { return portletPreferencesPersistence.fetchByPrimaryKey(portletPreferencesId); } /** * Returns the portlet preferences with the primary key. * * @param portletPreferencesId the primary key of the portlet preferences * @return the portlet preferences * @throws PortalException if a portlet preferences with the primary key could not be found */ @Override public PortletPreferences getPortletPreferences(long portletPreferencesId) throws PortalException { return portletPreferencesPersistence.findByPrimaryKey(portletPreferencesId); } @Override public ActionableDynamicQuery getActionableDynamicQuery() { ActionableDynamicQuery actionableDynamicQuery = new DefaultActionableDynamicQuery(); actionableDynamicQuery.setBaseLocalService(portletPreferencesLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(PortletPreferences.class); actionableDynamicQuery.setPrimaryKeyPropertyName("portletPreferencesId"); return actionableDynamicQuery; } @Override public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { IndexableActionableDynamicQuery indexableActionableDynamicQuery = new IndexableActionableDynamicQuery(); indexableActionableDynamicQuery.setBaseLocalService(portletPreferencesLocalService); indexableActionableDynamicQuery.setClassLoader(getClassLoader()); indexableActionableDynamicQuery.setModelClass(PortletPreferences.class); indexableActionableDynamicQuery.setPrimaryKeyPropertyName( "portletPreferencesId"); return indexableActionableDynamicQuery; } protected void initActionableDynamicQuery( ActionableDynamicQuery actionableDynamicQuery) { actionableDynamicQuery.setBaseLocalService(portletPreferencesLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(PortletPreferences.class); actionableDynamicQuery.setPrimaryKeyPropertyName("portletPreferencesId"); } /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException { return portletPreferencesLocalService.deletePortletPreferences((PortletPreferences)persistedModel); } @Override public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException { return portletPreferencesPersistence.findByPrimaryKey(primaryKeyObj); } /** * Returns a range of all the portlet preferenceses. * * <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.PortletPreferencesModelImpl}. 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 portlet preferenceses * @param end the upper bound of the range of portlet preferenceses (not inclusive) * @return the range of portlet preferenceses */ @Override public List<PortletPreferences> getPortletPreferenceses(int start, int end) { return portletPreferencesPersistence.findAll(start, end); } /** * Returns the number of portlet preferenceses. * * @return the number of portlet preferenceses */ @Override public int getPortletPreferencesesCount() { return portletPreferencesPersistence.countAll(); } /** * Updates the portlet preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param portletPreferences the portlet preferences * @return the portlet preferences that was updated */ @Indexable(type = IndexableType.REINDEX) @Override public PortletPreferences updatePortletPreferences( PortletPreferences portletPreferences) { return portletPreferencesPersistence.update(portletPreferences); } /** * Returns the portlet preferences local service. * * @return the portlet preferences local service */ public PortletPreferencesLocalService getPortletPreferencesLocalService() { return portletPreferencesLocalService; } /** * Sets the portlet preferences local service. * * @param portletPreferencesLocalService the portlet preferences local service */ public void setPortletPreferencesLocalService( 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 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 layout local service. * * @return the layout local service */ public com.liferay.portal.kernel.service.LayoutLocalService getLayoutLocalService() { return layoutLocalService; } /** * Sets the layout local service. * * @param layoutLocalService the layout local service */ public void setLayoutLocalService( com.liferay.portal.kernel.service.LayoutLocalService layoutLocalService) { this.layoutLocalService = layoutLocalService; } /** * Returns the layout persistence. * * @return the layout persistence */ public LayoutPersistence getLayoutPersistence() { return layoutPersistence; } /** * Sets the layout persistence. * * @param layoutPersistence the layout persistence */ public void setLayoutPersistence(LayoutPersistence layoutPersistence) { this.layoutPersistence = layoutPersistence; } /** * Returns the layout finder. * * @return the layout finder */ public LayoutFinder getLayoutFinder() { return layoutFinder; } /** * Sets the layout finder. * * @param layoutFinder the layout finder */ public void setLayoutFinder(LayoutFinder layoutFinder) { this.layoutFinder = layoutFinder; } /** * Returns the layout revision local service. * * @return the layout revision local service */ public com.liferay.portal.kernel.service.LayoutRevisionLocalService getLayoutRevisionLocalService() { return layoutRevisionLocalService; } /** * Sets the layout revision local service. * * @param layoutRevisionLocalService the layout revision local service */ public void setLayoutRevisionLocalService( com.liferay.portal.kernel.service.LayoutRevisionLocalService layoutRevisionLocalService) { this.layoutRevisionLocalService = layoutRevisionLocalService; } /** * Returns the layout revision persistence. * * @return the layout revision persistence */ public LayoutRevisionPersistence getLayoutRevisionPersistence() { return layoutRevisionPersistence; } /** * Sets the layout revision persistence. * * @param layoutRevisionPersistence the layout revision persistence */ public void setLayoutRevisionPersistence( LayoutRevisionPersistence layoutRevisionPersistence) { this.layoutRevisionPersistence = layoutRevisionPersistence; } /** * Returns the portlet local service. * * @return the portlet local service */ public com.liferay.portal.kernel.service.PortletLocalService getPortletLocalService() { return portletLocalService; } /** * Sets the portlet local service. * * @param portletLocalService the portlet local service */ public void setPortletLocalService( com.liferay.portal.kernel.service.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 portlet item local service. * * @return the portlet item local service */ public com.liferay.portal.kernel.service.PortletItemLocalService getPortletItemLocalService() { return portletItemLocalService; } /** * Sets the portlet item local service. * * @param portletItemLocalService the portlet item local service */ public void setPortletItemLocalService( com.liferay.portal.kernel.service.PortletItemLocalService portletItemLocalService) { this.portletItemLocalService = portletItemLocalService; } /** * Returns the portlet item persistence. * * @return the portlet item persistence */ public PortletItemPersistence getPortletItemPersistence() { return portletItemPersistence; } /** * Sets the portlet item persistence. * * @param portletItemPersistence the portlet item persistence */ public void setPortletItemPersistence( PortletItemPersistence portletItemPersistence) { this.portletItemPersistence = portletItemPersistence; } /** * Returns the user local service. * * @return the user local service */ public com.liferay.portal.kernel.service.UserLocalService getUserLocalService() { return userLocalService; } /** * Sets the user local service. * * @param userLocalService the user local service */ public void setUserLocalService( com.liferay.portal.kernel.service.UserLocalService userLocalService) { this.userLocalService = userLocalService; } /** * Returns the user persistence. * * @return the user persistence */ public UserPersistence getUserPersistence() { return userPersistence; } /** * Sets the user persistence. * * @param userPersistence the user persistence */ public void setUserPersistence(UserPersistence userPersistence) { this.userPersistence = userPersistence; } /** * Returns the user finder. * * @return the user finder */ public UserFinder getUserFinder() { return userFinder; } /** * Sets the user finder. * * @param userFinder the user finder */ public void setUserFinder(UserFinder userFinder) { this.userFinder = userFinder; } public void afterPropertiesSet() { persistedModelLocalServiceRegistry.register("com.liferay.portal.kernel.model.PortletPreferences", portletPreferencesLocalService); } public void destroy() { persistedModelLocalServiceRegistry.unregister( "com.liferay.portal.kernel.model.PortletPreferences"); } /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ @Override public String getOSGiServiceIdentifier() { return PortletPreferencesLocalService.class.getName(); } protected Class<?> getModelClass() { return PortletPreferences.class; } protected String getModelClassName() { return PortletPreferences.class.getName(); } /** * Performs a SQL query. * * @param sql the sql query */ protected void runSQL(String sql) { try { DataSource dataSource = portletPreferencesPersistence.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 = PortletPreferencesLocalService.class) protected PortletPreferencesLocalService portletPreferencesLocalService; @BeanReference(type = PortletPreferencesPersistence.class) protected PortletPreferencesPersistence portletPreferencesPersistence; @BeanReference(type = PortletPreferencesFinder.class) protected PortletPreferencesFinder portletPreferencesFinder; @BeanReference(type = com.liferay.counter.kernel.service.CounterLocalService.class) protected com.liferay.counter.kernel.service.CounterLocalService counterLocalService; @BeanReference(type = com.liferay.portal.kernel.service.LayoutLocalService.class) protected com.liferay.portal.kernel.service.LayoutLocalService layoutLocalService; @BeanReference(type = LayoutPersistence.class) protected LayoutPersistence layoutPersistence; @BeanReference(type = LayoutFinder.class) protected LayoutFinder layoutFinder; @BeanReference(type = com.liferay.portal.kernel.service.LayoutRevisionLocalService.class) protected com.liferay.portal.kernel.service.LayoutRevisionLocalService layoutRevisionLocalService; @BeanReference(type = LayoutRevisionPersistence.class) protected LayoutRevisionPersistence layoutRevisionPersistence; @BeanReference(type = com.liferay.portal.kernel.service.PortletLocalService.class) protected com.liferay.portal.kernel.service.PortletLocalService portletLocalService; @BeanReference(type = PortletPersistence.class) protected PortletPersistence portletPersistence; @BeanReference(type = com.liferay.portal.kernel.service.PortletItemLocalService.class) protected com.liferay.portal.kernel.service.PortletItemLocalService portletItemLocalService; @BeanReference(type = PortletItemPersistence.class) protected PortletItemPersistence portletItemPersistence; @BeanReference(type = com.liferay.portal.kernel.service.UserLocalService.class) protected com.liferay.portal.kernel.service.UserLocalService userLocalService; @BeanReference(type = UserPersistence.class) protected UserPersistence userPersistence; @BeanReference(type = UserFinder.class) protected UserFinder userFinder; @BeanReference(type = PersistedModelLocalServiceRegistry.class) protected PersistedModelLocalServiceRegistry persistedModelLocalServiceRegistry; }