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.liferay.blade.samples.servicebuilder.adq.service.base; import aQute.bnd.annotation.ProviderType; import com.liferay.asset.kernel.service.persistence.AssetEntryPersistence; import com.liferay.asset.kernel.service.persistence.AssetTagPersistence; import com.liferay.blade.samples.servicebuilder.adq.model.Bar; import com.liferay.blade.samples.servicebuilder.adq.service.BarLocalService; import com.liferay.blade.samples.servicebuilder.adq.service.persistence.BarPersistence; import com.liferay.exportimport.kernel.lar.ExportImportHelperUtil; import com.liferay.exportimport.kernel.lar.ManifestSummary; import com.liferay.exportimport.kernel.lar.PortletDataContext; import com.liferay.exportimport.kernel.lar.StagedModelDataHandlerUtil; import com.liferay.exportimport.kernel.lar.StagedModelType; 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.ExportActionableDynamicQuery; 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 bar 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.blade.samples.servicebuilder.adq.service.impl.BarLocalServiceImpl}. * </p> * * @author Brian Wing Shun Chan * @see com.liferay.blade.samples.servicebuilder.adq.service.impl.BarLocalServiceImpl * @see com.liferay.blade.samples.servicebuilder.adq.service.BarLocalServiceUtil * @generated */ @ProviderType public abstract class BarLocalServiceBaseImpl extends BaseLocalServiceImpl implements BarLocalService, IdentifiableOSGiService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this class directly. Always use {@link com.liferay.blade.samples.servicebuilder.adq.service.BarLocalServiceUtil} to access the bar local service. */ /** * Adds the bar to the database. Also notifies the appropriate model listeners. * * @param bar the bar * @return the bar that was added */ @Indexable(type = IndexableType.REINDEX) @Override public Bar addBar(Bar bar) { bar.setNew(true); return barPersistence.update(bar); } /** * Creates a new bar with the primary key. Does not add the bar to the database. * * @param barId the primary key for the new bar * @return the new bar */ @Override public Bar createBar(long barId) { return barPersistence.create(barId); } /** * Deletes the bar with the primary key from the database. Also notifies the appropriate model listeners. * * @param barId the primary key of the bar * @return the bar that was removed * @throws PortalException if a bar with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) @Override public Bar deleteBar(long barId) throws PortalException { return barPersistence.remove(barId); } /** * Deletes the bar from the database. Also notifies the appropriate model listeners. * * @param bar the bar * @return the bar that was removed */ @Indexable(type = IndexableType.DELETE) @Override public Bar deleteBar(Bar bar) { return barPersistence.remove(bar); } @Override public DynamicQuery dynamicQuery() { Class<?> clazz = getClass(); return DynamicQueryFactoryUtil.forClass(Bar.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 barPersistence.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.blade.samples.servicebuilder.adq.model.impl.BarModelImpl}. 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 barPersistence.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.blade.samples.servicebuilder.adq.model.impl.BarModelImpl}. 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 barPersistence.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 barPersistence.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 barPersistence.countWithDynamicQuery(dynamicQuery, projection); } @Override public Bar fetchBar(long barId) { return barPersistence.fetchByPrimaryKey(barId); } /** * Returns the bar matching the UUID and group. * * @param uuid the bar's UUID * @param groupId the primary key of the group * @return the matching bar, or <code>null</code> if a matching bar could not be found */ @Override public Bar fetchBarByUuidAndGroupId(String uuid, long groupId) { return barPersistence.fetchByUUID_G(uuid, groupId); } /** * Returns the bar with the primary key. * * @param barId the primary key of the bar * @return the bar * @throws PortalException if a bar with the primary key could not be found */ @Override public Bar getBar(long barId) throws PortalException { return barPersistence.findByPrimaryKey(barId); } @Override public ActionableDynamicQuery getActionableDynamicQuery() { ActionableDynamicQuery actionableDynamicQuery = new DefaultActionableDynamicQuery(); actionableDynamicQuery.setBaseLocalService(barLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(Bar.class); actionableDynamicQuery.setPrimaryKeyPropertyName("barId"); return actionableDynamicQuery; } @Override public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { IndexableActionableDynamicQuery indexableActionableDynamicQuery = new IndexableActionableDynamicQuery(); indexableActionableDynamicQuery.setBaseLocalService(barLocalService); indexableActionableDynamicQuery.setClassLoader(getClassLoader()); indexableActionableDynamicQuery.setModelClass(Bar.class); indexableActionableDynamicQuery.setPrimaryKeyPropertyName("barId"); return indexableActionableDynamicQuery; } protected void initActionableDynamicQuery(ActionableDynamicQuery actionableDynamicQuery) { actionableDynamicQuery.setBaseLocalService(barLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(Bar.class); actionableDynamicQuery.setPrimaryKeyPropertyName("barId"); } @Override public ExportActionableDynamicQuery getExportActionableDynamicQuery( final PortletDataContext portletDataContext) { final ExportActionableDynamicQuery exportActionableDynamicQuery = new ExportActionableDynamicQuery() { @Override public long performCount() throws PortalException { ManifestSummary manifestSummary = portletDataContext.getManifestSummary(); StagedModelType stagedModelType = getStagedModelType(); long modelAdditionCount = super.performCount(); manifestSummary.addModelAdditionCount(stagedModelType, modelAdditionCount); long modelDeletionCount = ExportImportHelperUtil.getModelDeletionCount(portletDataContext, stagedModelType); manifestSummary.addModelDeletionCount(stagedModelType, modelDeletionCount); return modelAdditionCount; } }; initActionableDynamicQuery(exportActionableDynamicQuery); exportActionableDynamicQuery.setAddCriteriaMethod(new ActionableDynamicQuery.AddCriteriaMethod() { @Override public void addCriteria(DynamicQuery dynamicQuery) { portletDataContext.addDateRangeCriteria(dynamicQuery, "modifiedDate"); } }); exportActionableDynamicQuery.setCompanyId(portletDataContext.getCompanyId()); exportActionableDynamicQuery.setPerformActionMethod(new ActionableDynamicQuery.PerformActionMethod<Bar>() { @Override public void performAction(Bar bar) throws PortalException { StagedModelDataHandlerUtil.exportStagedModel(portletDataContext, bar); } }); exportActionableDynamicQuery .setStagedModelType(new StagedModelType(PortalUtil.getClassNameId(Bar.class.getName()))); return exportActionableDynamicQuery; } /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException { return barLocalService.deleteBar((Bar) persistedModel); } @Override public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException { return barPersistence.findByPrimaryKey(primaryKeyObj); } /** * Returns all the bars matching the UUID and company. * * @param uuid the UUID of the bars * @param companyId the primary key of the company * @return the matching bars, or an empty list if no matches were found */ @Override public List<Bar> getBarsByUuidAndCompanyId(String uuid, long companyId) { return barPersistence.findByUuid_C(uuid, companyId); } /** * Returns a range of bars matching the UUID and company. * * @param uuid the UUID of the bars * @param companyId the primary key of the company * @param start the lower bound of the range of bars * @param end the upper bound of the range of bars (not inclusive) * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) * @return the range of matching bars, or an empty list if no matches were found */ @Override public List<Bar> getBarsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<Bar> orderByComparator) { return barPersistence.findByUuid_C(uuid, companyId, start, end, orderByComparator); } /** * Returns the bar matching the UUID and group. * * @param uuid the bar's UUID * @param groupId the primary key of the group * @return the matching bar * @throws PortalException if a matching bar could not be found */ @Override public Bar getBarByUuidAndGroupId(String uuid, long groupId) throws PortalException { return barPersistence.findByUUID_G(uuid, groupId); } /** * Returns a range of all the bars. * * <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.blade.samples.servicebuilder.adq.model.impl.BarModelImpl}. 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 bars * @param end the upper bound of the range of bars (not inclusive) * @return the range of bars */ @Override public List<Bar> getBars(int start, int end) { return barPersistence.findAll(start, end); } /** * Returns the number of bars. * * @return the number of bars */ @Override public int getBarsCount() { return barPersistence.countAll(); } /** * Updates the bar in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param bar the bar * @return the bar that was updated */ @Indexable(type = IndexableType.REINDEX) @Override public Bar updateBar(Bar bar) { return barPersistence.update(bar); } /** * Returns the bar local service. * * @return the bar local service */ public BarLocalService getBarLocalService() { return barLocalService; } /** * Sets the bar local service. * * @param barLocalService the bar local service */ public void setBarLocalService(BarLocalService barLocalService) { this.barLocalService = barLocalService; } /** * Returns the bar persistence. * * @return the bar persistence */ public BarPersistence getBarPersistence() { return barPersistence; } /** * Sets the bar persistence. * * @param barPersistence the bar persistence */ public void setBarPersistence(BarPersistence barPersistence) { this.barPersistence = barPersistence; } /** * 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; } /** * Returns the asset entry local service. * * @return the asset entry local service */ public com.liferay.asset.kernel.service.AssetEntryLocalService getAssetEntryLocalService() { return assetEntryLocalService; } /** * Sets the asset entry local service. * * @param assetEntryLocalService the asset entry local service */ public void setAssetEntryLocalService( com.liferay.asset.kernel.service.AssetEntryLocalService assetEntryLocalService) { this.assetEntryLocalService = assetEntryLocalService; } /** * Returns the asset entry persistence. * * @return the asset entry persistence */ public AssetEntryPersistence getAssetEntryPersistence() { return assetEntryPersistence; } /** * Sets the asset entry persistence. * * @param assetEntryPersistence the asset entry persistence */ public void setAssetEntryPersistence(AssetEntryPersistence assetEntryPersistence) { this.assetEntryPersistence = assetEntryPersistence; } /** * Returns the asset tag local service. * * @return the asset tag local service */ public com.liferay.asset.kernel.service.AssetTagLocalService getAssetTagLocalService() { return assetTagLocalService; } /** * Sets the asset tag local service. * * @param assetTagLocalService the asset tag local service */ public void setAssetTagLocalService( com.liferay.asset.kernel.service.AssetTagLocalService assetTagLocalService) { this.assetTagLocalService = assetTagLocalService; } /** * Returns the asset tag persistence. * * @return the asset tag persistence */ public AssetTagPersistence getAssetTagPersistence() { return assetTagPersistence; } /** * Sets the asset tag persistence. * * @param assetTagPersistence the asset tag persistence */ public void setAssetTagPersistence(AssetTagPersistence assetTagPersistence) { this.assetTagPersistence = assetTagPersistence; } public void afterPropertiesSet() { persistedModelLocalServiceRegistry.register("com.liferay.blade.samples.servicebuilder.adq.model.Bar", barLocalService); } public void destroy() { persistedModelLocalServiceRegistry.unregister("com.liferay.blade.samples.servicebuilder.adq.model.Bar"); } /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ @Override public String getOSGiServiceIdentifier() { return BarLocalService.class.getName(); } protected Class<?> getModelClass() { return Bar.class; } protected String getModelClassName() { return Bar.class.getName(); } /** * Performs a SQL query. * * @param sql the sql query */ protected void runSQL(String sql) { try { DataSource dataSource = barPersistence.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 = BarLocalService.class) protected BarLocalService barLocalService; @BeanReference(type = BarPersistence.class) protected BarPersistence barPersistence; @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 = com.liferay.asset.kernel.service.AssetEntryLocalService.class) protected com.liferay.asset.kernel.service.AssetEntryLocalService assetEntryLocalService; @ServiceReference(type = AssetEntryPersistence.class) protected AssetEntryPersistence assetEntryPersistence; @ServiceReference(type = com.liferay.asset.kernel.service.AssetTagLocalService.class) protected com.liferay.asset.kernel.service.AssetTagLocalService assetTagLocalService; @ServiceReference(type = AssetTagPersistence.class) protected AssetTagPersistence assetTagPersistence; @ServiceReference(type = PersistedModelLocalServiceRegistry.class) protected PersistedModelLocalServiceRegistry persistedModelLocalServiceRegistry; }