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.carriers.service.base; import aQute.bnd.annotation.ProviderType; import com.bemis.portal.carriers.model.Carrier; import com.bemis.portal.carriers.service.CarrierLocalService; import com.bemis.portal.carriers.service.persistence.CarrierPersistence; import com.liferay.asset.kernel.service.persistence.AssetEntryPersistence; import com.liferay.asset.kernel.service.persistence.AssetLinkPersistence; 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 carrier 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.carriers.service.impl.CarrierLocalServiceImpl}. * </p> * * @author Thuong Dinh * @see com.bemis.portal.carriers.service.impl.CarrierLocalServiceImpl * @see com.bemis.portal.carriers.service.CarrierLocalServiceUtil * @generated */ @ProviderType public abstract class CarrierLocalServiceBaseImpl extends BaseLocalServiceImpl implements CarrierLocalService, IdentifiableOSGiService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this class directly. Always use {@link com.bemis.portal.carriers.service.CarrierLocalServiceUtil} to access the carrier local service. */ /** * Adds the carrier to the database. Also notifies the appropriate model listeners. * * @param carrier the carrier * @return the carrier that was added */ @Indexable(type = IndexableType.REINDEX) @Override public Carrier addCarrier(Carrier carrier) { carrier.setNew(true); return carrierPersistence.update(carrier); } /** * Creates a new carrier with the primary key. Does not add the carrier to the database. * * @param carrierId the primary key for the new carrier * @return the new carrier */ @Override public Carrier createCarrier(long carrierId) { return carrierPersistence.create(carrierId); } /** * Deletes the carrier with the primary key from the database. Also notifies the appropriate model listeners. * * @param carrierId the primary key of the carrier * @return the carrier that was removed * @throws PortalException if a carrier with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) @Override public Carrier deleteCarrier(long carrierId) throws PortalException { return carrierPersistence.remove(carrierId); } /** * Deletes the carrier from the database. Also notifies the appropriate model listeners. * * @param carrier the carrier * @return the carrier that was removed */ @Indexable(type = IndexableType.DELETE) @Override public Carrier deleteCarrier(Carrier carrier) { return carrierPersistence.remove(carrier); } @Override public DynamicQuery dynamicQuery() { Class<?> clazz = getClass(); return DynamicQueryFactoryUtil.forClass(Carrier.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 carrierPersistence.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.carriers.model.impl.CarrierModelImpl}. 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 carrierPersistence.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.carriers.model.impl.CarrierModelImpl}. 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 carrierPersistence.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 carrierPersistence.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 carrierPersistence.countWithDynamicQuery(dynamicQuery, projection); } @Override public Carrier fetchCarrier(long carrierId) { return carrierPersistence.fetchByPrimaryKey(carrierId); } /** * Returns the carrier matching the UUID and group. * * @param uuid the carrier's UUID * @param groupId the primary key of the group * @return the matching carrier, or <code>null</code> if a matching carrier could not be found */ @Override public Carrier fetchCarrierByUuidAndGroupId(String uuid, long groupId) { return carrierPersistence.fetchByUUID_G(uuid, groupId); } /** * Returns the carrier with the primary key. * * @param carrierId the primary key of the carrier * @return the carrier * @throws PortalException if a carrier with the primary key could not be found */ @Override public Carrier getCarrier(long carrierId) throws PortalException { return carrierPersistence.findByPrimaryKey(carrierId); } @Override public ActionableDynamicQuery getActionableDynamicQuery() { ActionableDynamicQuery actionableDynamicQuery = new DefaultActionableDynamicQuery(); actionableDynamicQuery.setBaseLocalService(carrierLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(Carrier.class); actionableDynamicQuery.setPrimaryKeyPropertyName("carrierId"); return actionableDynamicQuery; } @Override public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { IndexableActionableDynamicQuery indexableActionableDynamicQuery = new IndexableActionableDynamicQuery(); indexableActionableDynamicQuery.setBaseLocalService(carrierLocalService); indexableActionableDynamicQuery.setClassLoader(getClassLoader()); indexableActionableDynamicQuery.setModelClass(Carrier.class); indexableActionableDynamicQuery.setPrimaryKeyPropertyName("carrierId"); return indexableActionableDynamicQuery; } protected void initActionableDynamicQuery(ActionableDynamicQuery actionableDynamicQuery) { actionableDynamicQuery.setBaseLocalService(carrierLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(Carrier.class); actionableDynamicQuery.setPrimaryKeyPropertyName("carrierId"); } @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<Carrier>() { @Override public void performAction(Carrier carrier) throws PortalException { StagedModelDataHandlerUtil.exportStagedModel(portletDataContext, carrier); } }); exportActionableDynamicQuery .setStagedModelType(new StagedModelType(PortalUtil.getClassNameId(Carrier.class.getName()))); return exportActionableDynamicQuery; } /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException { return carrierLocalService.deleteCarrier((Carrier) persistedModel); } @Override public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException { return carrierPersistence.findByPrimaryKey(primaryKeyObj); } /** * Returns all the carriers matching the UUID and company. * * @param uuid the UUID of the carriers * @param companyId the primary key of the company * @return the matching carriers, or an empty list if no matches were found */ @Override public List<Carrier> getCarriersByUuidAndCompanyId(String uuid, long companyId) { return carrierPersistence.findByUuid_C(uuid, companyId); } /** * Returns a range of carriers matching the UUID and company. * * @param uuid the UUID of the carriers * @param companyId the primary key of the company * @param start the lower bound of the range of carriers * @param end the upper bound of the range of carriers (not inclusive) * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) * @return the range of matching carriers, or an empty list if no matches were found */ @Override public List<Carrier> getCarriersByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<Carrier> orderByComparator) { return carrierPersistence.findByUuid_C(uuid, companyId, start, end, orderByComparator); } /** * Returns the carrier matching the UUID and group. * * @param uuid the carrier's UUID * @param groupId the primary key of the group * @return the matching carrier * @throws PortalException if a matching carrier could not be found */ @Override public Carrier getCarrierByUuidAndGroupId(String uuid, long groupId) throws PortalException { return carrierPersistence.findByUUID_G(uuid, groupId); } /** * Returns a range of all the carriers. * * <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.carriers.model.impl.CarrierModelImpl}. 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 carriers * @param end the upper bound of the range of carriers (not inclusive) * @return the range of carriers */ @Override public List<Carrier> getCarriers(int start, int end) { return carrierPersistence.findAll(start, end); } /** * Returns the number of carriers. * * @return the number of carriers */ @Override public int getCarriersCount() { return carrierPersistence.countAll(); } /** * Updates the carrier in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param carrier the carrier * @return the carrier that was updated */ @Indexable(type = IndexableType.REINDEX) @Override public Carrier updateCarrier(Carrier carrier) { return carrierPersistence.update(carrier); } /** * Returns the carrier local service. * * @return the carrier local service */ public CarrierLocalService getCarrierLocalService() { return carrierLocalService; } /** * Sets the carrier local service. * * @param carrierLocalService the carrier local service */ public void setCarrierLocalService(CarrierLocalService carrierLocalService) { this.carrierLocalService = carrierLocalService; } /** * Returns the carrier persistence. * * @return the carrier persistence */ public CarrierPersistence getCarrierPersistence() { return carrierPersistence; } /** * Sets the carrier persistence. * * @param carrierPersistence the carrier persistence */ public void setCarrierPersistence(CarrierPersistence carrierPersistence) { this.carrierPersistence = carrierPersistence; } /** * 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 link local service. * * @return the asset link local service */ public com.liferay.asset.kernel.service.AssetLinkLocalService getAssetLinkLocalService() { return assetLinkLocalService; } /** * Sets the asset link local service. * * @param assetLinkLocalService the asset link local service */ public void setAssetLinkLocalService( com.liferay.asset.kernel.service.AssetLinkLocalService assetLinkLocalService) { this.assetLinkLocalService = assetLinkLocalService; } /** * Returns the asset link persistence. * * @return the asset link persistence */ public AssetLinkPersistence getAssetLinkPersistence() { return assetLinkPersistence; } /** * Sets the asset link persistence. * * @param assetLinkPersistence the asset link persistence */ public void setAssetLinkPersistence(AssetLinkPersistence assetLinkPersistence) { this.assetLinkPersistence = assetLinkPersistence; } public void afterPropertiesSet() { persistedModelLocalServiceRegistry.register("com.bemis.portal.carriers.model.Carrier", carrierLocalService); } public void destroy() { persistedModelLocalServiceRegistry.unregister("com.bemis.portal.carriers.model.Carrier"); } /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ @Override public String getOSGiServiceIdentifier() { return CarrierLocalService.class.getName(); } protected Class<?> getModelClass() { return Carrier.class; } protected String getModelClassName() { return Carrier.class.getName(); } /** * Performs a SQL query. * * @param sql the sql query */ protected void runSQL(String sql) { try { DataSource dataSource = carrierPersistence.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 = CarrierLocalService.class) protected CarrierLocalService carrierLocalService; @BeanReference(type = CarrierPersistence.class) protected CarrierPersistence carrierPersistence; @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.AssetLinkLocalService.class) protected com.liferay.asset.kernel.service.AssetLinkLocalService assetLinkLocalService; @ServiceReference(type = AssetLinkPersistence.class) protected AssetLinkPersistence assetLinkPersistence; @ServiceReference(type = PersistedModelLocalServiceRegistry.class) protected PersistedModelLocalServiceRegistry persistedModelLocalServiceRegistry; }