Java tutorial
/** * 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.bemis.portal.report.service.base; import aQute.bnd.annotation.ProviderType; import com.bemis.portal.report.model.ReportDefinition; import com.bemis.portal.report.service.ReportDefinitionLocalService; import com.bemis.portal.report.service.persistence.ReportDefinitionPersistence; import com.bemis.portal.report.service.persistence.ReportPreferencesPersistence; import com.bemis.portal.report.service.persistence.ReportRequestPersistence; 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.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.persistence.ClassNamePersistence; import com.liferay.portal.kernel.service.persistence.UserPersistence; import com.liferay.portal.kernel.util.OrderByComparator; import com.liferay.portal.kernel.util.PortalUtil; import com.liferay.portal.spring.extender.service.ServiceReference; import java.io.Serializable; import java.util.List; import javax.sql.DataSource; /** * Provides the base implementation for the report definition 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.bemis.portal.report.service.impl.ReportDefinitionLocalServiceImpl}. * </p> * * @author Michael C. Han * @see com.bemis.portal.report.service.impl.ReportDefinitionLocalServiceImpl * @see com.bemis.portal.report.service.ReportDefinitionLocalServiceUtil * @generated */ @ProviderType public abstract class ReportDefinitionLocalServiceBaseImpl extends BaseLocalServiceImpl implements ReportDefinitionLocalService, IdentifiableOSGiService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this class directly. Always use {@link com.bemis.portal.report.service.ReportDefinitionLocalServiceUtil} to access the report definition local service. */ /** * Adds the report definition to the database. Also notifies the appropriate model listeners. * * @param reportDefinition the report definition * @return the report definition that was added */ @Indexable(type = IndexableType.REINDEX) @Override public ReportDefinition addReportDefinition(ReportDefinition reportDefinition) { reportDefinition.setNew(true); return reportDefinitionPersistence.update(reportDefinition); } /** * Creates a new report definition with the primary key. Does not add the report definition to the database. * * @param reportDefinitionId the primary key for the new report definition * @return the new report definition */ @Override public ReportDefinition createReportDefinition(long reportDefinitionId) { return reportDefinitionPersistence.create(reportDefinitionId); } /** * Deletes the report definition with the primary key from the database. Also notifies the appropriate model listeners. * * @param reportDefinitionId the primary key of the report definition * @return the report definition that was removed * @throws PortalException if a report definition with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) @Override public ReportDefinition deleteReportDefinition(long reportDefinitionId) throws PortalException { return reportDefinitionPersistence.remove(reportDefinitionId); } /** * Deletes the report definition from the database. Also notifies the appropriate model listeners. * * @param reportDefinition the report definition * @return the report definition that was removed * @throws PortalException */ @Indexable(type = IndexableType.DELETE) @Override public ReportDefinition deleteReportDefinition(ReportDefinition reportDefinition) throws PortalException { return reportDefinitionPersistence.remove(reportDefinition); } @Override public DynamicQuery dynamicQuery() { Class<?> clazz = getClass(); return DynamicQueryFactoryUtil.forClass(ReportDefinition.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 reportDefinitionPersistence.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.bemis.portal.report.model.impl.ReportDefinitionModelImpl}. 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 reportDefinitionPersistence.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.bemis.portal.report.model.impl.ReportDefinitionModelImpl}. 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 reportDefinitionPersistence.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 reportDefinitionPersistence.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 reportDefinitionPersistence.countWithDynamicQuery(dynamicQuery, projection); } @Override public ReportDefinition fetchReportDefinition(long reportDefinitionId) { return reportDefinitionPersistence.fetchByPrimaryKey(reportDefinitionId); } /** * Returns the report definition with the primary key. * * @param reportDefinitionId the primary key of the report definition * @return the report definition * @throws PortalException if a report definition with the primary key could not be found */ @Override public ReportDefinition getReportDefinition(long reportDefinitionId) throws PortalException { return reportDefinitionPersistence.findByPrimaryKey(reportDefinitionId); } @Override public ActionableDynamicQuery getActionableDynamicQuery() { ActionableDynamicQuery actionableDynamicQuery = new DefaultActionableDynamicQuery(); actionableDynamicQuery.setBaseLocalService(reportDefinitionLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(ReportDefinition.class); actionableDynamicQuery.setPrimaryKeyPropertyName("reportDefinitionId"); return actionableDynamicQuery; } @Override public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { IndexableActionableDynamicQuery indexableActionableDynamicQuery = new IndexableActionableDynamicQuery(); indexableActionableDynamicQuery.setBaseLocalService(reportDefinitionLocalService); indexableActionableDynamicQuery.setClassLoader(getClassLoader()); indexableActionableDynamicQuery.setModelClass(ReportDefinition.class); indexableActionableDynamicQuery.setPrimaryKeyPropertyName("reportDefinitionId"); return indexableActionableDynamicQuery; } protected void initActionableDynamicQuery(ActionableDynamicQuery actionableDynamicQuery) { actionableDynamicQuery.setBaseLocalService(reportDefinitionLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(ReportDefinition.class); actionableDynamicQuery.setPrimaryKeyPropertyName("reportDefinitionId"); } /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException { return reportDefinitionLocalService.deleteReportDefinition((ReportDefinition) persistedModel); } @Override public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException { return reportDefinitionPersistence.findByPrimaryKey(primaryKeyObj); } /** * Returns a range of all the report definitions. * * <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.bemis.portal.report.model.impl.ReportDefinitionModelImpl}. 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 report definitions * @param end the upper bound of the range of report definitions (not inclusive) * @return the range of report definitions */ @Override public List<ReportDefinition> getReportDefinitions(int start, int end) { return reportDefinitionPersistence.findAll(start, end); } /** * Returns the number of report definitions. * * @return the number of report definitions */ @Override public int getReportDefinitionsCount() { return reportDefinitionPersistence.countAll(); } /** * Updates the report definition in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param reportDefinition the report definition * @return the report definition that was updated */ @Indexable(type = IndexableType.REINDEX) @Override public ReportDefinition updateReportDefinition(ReportDefinition reportDefinition) { return reportDefinitionPersistence.update(reportDefinition); } /** * Returns the report definition local service. * * @return the report definition local service */ public ReportDefinitionLocalService getReportDefinitionLocalService() { return reportDefinitionLocalService; } /** * Sets the report definition local service. * * @param reportDefinitionLocalService the report definition local service */ public void setReportDefinitionLocalService(ReportDefinitionLocalService reportDefinitionLocalService) { this.reportDefinitionLocalService = reportDefinitionLocalService; } /** * Returns the report definition persistence. * * @return the report definition persistence */ public ReportDefinitionPersistence getReportDefinitionPersistence() { return reportDefinitionPersistence; } /** * Sets the report definition persistence. * * @param reportDefinitionPersistence the report definition persistence */ public void setReportDefinitionPersistence(ReportDefinitionPersistence reportDefinitionPersistence) { this.reportDefinitionPersistence = reportDefinitionPersistence; } /** * Returns the report preferences local service. * * @return the report preferences local service */ public com.bemis.portal.report.service.ReportPreferencesLocalService getReportPreferencesLocalService() { return reportPreferencesLocalService; } /** * Sets the report preferences local service. * * @param reportPreferencesLocalService the report preferences local service */ public void setReportPreferencesLocalService( com.bemis.portal.report.service.ReportPreferencesLocalService reportPreferencesLocalService) { this.reportPreferencesLocalService = reportPreferencesLocalService; } /** * Returns the report preferences persistence. * * @return the report preferences persistence */ public ReportPreferencesPersistence getReportPreferencesPersistence() { return reportPreferencesPersistence; } /** * Sets the report preferences persistence. * * @param reportPreferencesPersistence the report preferences persistence */ public void setReportPreferencesPersistence(ReportPreferencesPersistence reportPreferencesPersistence) { this.reportPreferencesPersistence = reportPreferencesPersistence; } /** * Returns the report request local service. * * @return the report request local service */ public com.bemis.portal.report.service.ReportRequestLocalService getReportRequestLocalService() { return reportRequestLocalService; } /** * Sets the report request local service. * * @param reportRequestLocalService the report request local service */ public void setReportRequestLocalService( com.bemis.portal.report.service.ReportRequestLocalService reportRequestLocalService) { this.reportRequestLocalService = reportRequestLocalService; } /** * Returns the report request persistence. * * @return the report request persistence */ public ReportRequestPersistence getReportRequestPersistence() { return reportRequestPersistence; } /** * Sets the report request persistence. * * @param reportRequestPersistence the report request persistence */ public void setReportRequestPersistence(ReportRequestPersistence reportRequestPersistence) { this.reportRequestPersistence = reportRequestPersistence; } /** * 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 class name local service. * * @return the class name local service */ public com.liferay.portal.kernel.service.ClassNameLocalService getClassNameLocalService() { return classNameLocalService; } /** * Sets the class name local service. * * @param classNameLocalService the class name local service */ public void setClassNameLocalService( com.liferay.portal.kernel.service.ClassNameLocalService classNameLocalService) { this.classNameLocalService = classNameLocalService; } /** * Returns the class name persistence. * * @return the class name persistence */ public ClassNamePersistence getClassNamePersistence() { return classNamePersistence; } /** * Sets the class name persistence. * * @param classNamePersistence the class name persistence */ public void setClassNamePersistence(ClassNamePersistence classNamePersistence) { this.classNamePersistence = classNamePersistence; } /** * 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 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; } public void afterPropertiesSet() { persistedModelLocalServiceRegistry.register("com.bemis.portal.report.model.ReportDefinition", reportDefinitionLocalService); } public void destroy() { persistedModelLocalServiceRegistry.unregister("com.bemis.portal.report.model.ReportDefinition"); } /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ @Override public String getOSGiServiceIdentifier() { return ReportDefinitionLocalService.class.getName(); } protected Class<?> getModelClass() { return ReportDefinition.class; } protected String getModelClassName() { return ReportDefinition.class.getName(); } /** * Performs a SQL query. * * @param sql the sql query */ protected void runSQL(String sql) { try { DataSource dataSource = reportDefinitionPersistence.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 = ReportDefinitionLocalService.class) protected ReportDefinitionLocalService reportDefinitionLocalService; @BeanReference(type = ReportDefinitionPersistence.class) protected ReportDefinitionPersistence reportDefinitionPersistence; @BeanReference(type = com.bemis.portal.report.service.ReportPreferencesLocalService.class) protected com.bemis.portal.report.service.ReportPreferencesLocalService reportPreferencesLocalService; @BeanReference(type = ReportPreferencesPersistence.class) protected ReportPreferencesPersistence reportPreferencesPersistence; @BeanReference(type = com.bemis.portal.report.service.ReportRequestLocalService.class) protected com.bemis.portal.report.service.ReportRequestLocalService reportRequestLocalService; @BeanReference(type = ReportRequestPersistence.class) protected ReportRequestPersistence reportRequestPersistence; @ServiceReference(type = com.liferay.counter.kernel.service.CounterLocalService.class) protected com.liferay.counter.kernel.service.CounterLocalService counterLocalService; @ServiceReference(type = com.liferay.portal.kernel.service.ClassNameLocalService.class) protected com.liferay.portal.kernel.service.ClassNameLocalService classNameLocalService; @ServiceReference(type = ClassNamePersistence.class) protected ClassNamePersistence classNamePersistence; @ServiceReference(type = com.liferay.portal.kernel.service.ResourceLocalService.class) protected com.liferay.portal.kernel.service.ResourceLocalService resourceLocalService; @ServiceReference(type = com.liferay.portal.kernel.service.UserLocalService.class) protected com.liferay.portal.kernel.service.UserLocalService userLocalService; @ServiceReference(type = UserPersistence.class) protected UserPersistence userPersistence; @ServiceReference(type = PersistedModelLocalServiceRegistry.class) protected PersistedModelLocalServiceRegistry persistedModelLocalServiceRegistry; }