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.shipment.service.base; import aQute.bnd.annotation.ProviderType; import com.bemis.portal.shipment.model.Shipment; import com.bemis.portal.shipment.service.ShipmentLocalService; import com.bemis.portal.shipment.service.persistence.ShipmentPersistence; import com.liferay.asset.kernel.service.persistence.AssetEntryPersistence; import com.liferay.asset.kernel.service.persistence.AssetLinkPersistence; 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 shipment 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.shipment.service.impl.ShipmentLocalServiceImpl}. * </p> * * @author Thuong Dinh * @see com.bemis.portal.shipment.service.impl.ShipmentLocalServiceImpl * @see com.bemis.portal.shipment.service.ShipmentLocalServiceUtil * @generated */ @ProviderType public abstract class ShipmentLocalServiceBaseImpl extends BaseLocalServiceImpl implements ShipmentLocalService, IdentifiableOSGiService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this class directly. Always use {@link com.bemis.portal.shipment.service.ShipmentLocalServiceUtil} to access the shipment local service. */ /** * Adds the shipment to the database. Also notifies the appropriate model listeners. * * @param shipment the shipment * @return the shipment that was added */ @Indexable(type = IndexableType.REINDEX) @Override public Shipment addShipment(Shipment shipment) { shipment.setNew(true); return shipmentPersistence.update(shipment); } /** * Creates a new shipment with the primary key. Does not add the shipment to the database. * * @param shipmentId the primary key for the new shipment * @return the new shipment */ @Override public Shipment createShipment(long shipmentId) { return shipmentPersistence.create(shipmentId); } /** * Deletes the shipment with the primary key from the database. Also notifies the appropriate model listeners. * * @param shipmentId the primary key of the shipment * @return the shipment that was removed * @throws PortalException if a shipment with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) @Override public Shipment deleteShipment(long shipmentId) throws PortalException { return shipmentPersistence.remove(shipmentId); } /** * Deletes the shipment from the database. Also notifies the appropriate model listeners. * * @param shipment the shipment * @return the shipment that was removed */ @Indexable(type = IndexableType.DELETE) @Override public Shipment deleteShipment(Shipment shipment) { return shipmentPersistence.remove(shipment); } @Override public DynamicQuery dynamicQuery() { Class<?> clazz = getClass(); return DynamicQueryFactoryUtil.forClass(Shipment.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 shipmentPersistence.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.shipment.model.impl.ShipmentModelImpl}. 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 shipmentPersistence.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.shipment.model.impl.ShipmentModelImpl}. 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 shipmentPersistence.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 shipmentPersistence.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 shipmentPersistence.countWithDynamicQuery(dynamicQuery, projection); } @Override public Shipment fetchShipment(long shipmentId) { return shipmentPersistence.fetchByPrimaryKey(shipmentId); } /** * Returns the shipment with the primary key. * * @param shipmentId the primary key of the shipment * @return the shipment * @throws PortalException if a shipment with the primary key could not be found */ @Override public Shipment getShipment(long shipmentId) throws PortalException { return shipmentPersistence.findByPrimaryKey(shipmentId); } @Override public ActionableDynamicQuery getActionableDynamicQuery() { ActionableDynamicQuery actionableDynamicQuery = new DefaultActionableDynamicQuery(); actionableDynamicQuery.setBaseLocalService(shipmentLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(Shipment.class); actionableDynamicQuery.setPrimaryKeyPropertyName("shipmentId"); return actionableDynamicQuery; } @Override public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { IndexableActionableDynamicQuery indexableActionableDynamicQuery = new IndexableActionableDynamicQuery(); indexableActionableDynamicQuery.setBaseLocalService(shipmentLocalService); indexableActionableDynamicQuery.setClassLoader(getClassLoader()); indexableActionableDynamicQuery.setModelClass(Shipment.class); indexableActionableDynamicQuery.setPrimaryKeyPropertyName("shipmentId"); return indexableActionableDynamicQuery; } protected void initActionableDynamicQuery(ActionableDynamicQuery actionableDynamicQuery) { actionableDynamicQuery.setBaseLocalService(shipmentLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(Shipment.class); actionableDynamicQuery.setPrimaryKeyPropertyName("shipmentId"); } /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException { return shipmentLocalService.deleteShipment((Shipment) persistedModel); } @Override public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException { return shipmentPersistence.findByPrimaryKey(primaryKeyObj); } /** * Returns a range of all the shipments. * * <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.shipment.model.impl.ShipmentModelImpl}. 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 shipments * @param end the upper bound of the range of shipments (not inclusive) * @return the range of shipments */ @Override public List<Shipment> getShipments(int start, int end) { return shipmentPersistence.findAll(start, end); } /** * Returns the number of shipments. * * @return the number of shipments */ @Override public int getShipmentsCount() { return shipmentPersistence.countAll(); } /** * Updates the shipment in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param shipment the shipment * @return the shipment that was updated */ @Indexable(type = IndexableType.REINDEX) @Override public Shipment updateShipment(Shipment shipment) { return shipmentPersistence.update(shipment); } /** * Returns the shipment local service. * * @return the shipment local service */ public ShipmentLocalService getShipmentLocalService() { return shipmentLocalService; } /** * Sets the shipment local service. * * @param shipmentLocalService the shipment local service */ public void setShipmentLocalService(ShipmentLocalService shipmentLocalService) { this.shipmentLocalService = shipmentLocalService; } /** * Returns the shipment persistence. * * @return the shipment persistence */ public ShipmentPersistence getShipmentPersistence() { return shipmentPersistence; } /** * Sets the shipment persistence. * * @param shipmentPersistence the shipment persistence */ public void setShipmentPersistence(ShipmentPersistence shipmentPersistence) { this.shipmentPersistence = shipmentPersistence; } /** * 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.shipment.model.Shipment", shipmentLocalService); } public void destroy() { persistedModelLocalServiceRegistry.unregister("com.bemis.portal.shipment.model.Shipment"); } /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ @Override public String getOSGiServiceIdentifier() { return ShipmentLocalService.class.getName(); } protected Class<?> getModelClass() { return Shipment.class; } protected String getModelClassName() { return Shipment.class.getName(); } /** * Performs a SQL query. * * @param sql the sql query */ protected void runSQL(String sql) { try { DataSource dataSource = shipmentPersistence.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 = ShipmentLocalService.class) protected ShipmentLocalService shipmentLocalService; @BeanReference(type = ShipmentPersistence.class) protected ShipmentPersistence shipmentPersistence; @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; }