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 net.indaba.lostandfound.service.base; import aQute.bnd.annotation.ProviderType; 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.PersistedModelLocalServiceRegistryUtil; 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 net.indaba.lostandfound.model.Item; import net.indaba.lostandfound.service.ItemLocalService; import net.indaba.lostandfound.service.persistence.ItemPersistence; import net.indaba.lostandfound.service.persistence.LFImagePersistence; import java.io.Serializable; import java.util.List; import javax.sql.DataSource; /** * Provides the base implementation for the item 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 net.indaba.lostandfound.service.impl.ItemLocalServiceImpl}. * </p> * * @author aritz * @see net.indaba.lostandfound.service.impl.ItemLocalServiceImpl * @see net.indaba.lostandfound.service.ItemLocalServiceUtil * @generated */ @ProviderType public abstract class ItemLocalServiceBaseImpl extends BaseLocalServiceImpl implements ItemLocalService, IdentifiableOSGiService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this class directly. Always use {@link net.indaba.lostandfound.service.ItemLocalServiceUtil} to access the item local service. */ /** * Adds the item to the database. Also notifies the appropriate model listeners. * * @param item the item * @return the item that was added */ @Indexable(type = IndexableType.REINDEX) @Override public Item addItem(Item item) { item.setNew(true); return itemPersistence.update(item); } /** * Creates a new item with the primary key. Does not add the item to the database. * * @param itemId the primary key for the new item * @return the new item */ @Override public Item createItem(long itemId) { return itemPersistence.create(itemId); } /** * Deletes the item with the primary key from the database. Also notifies the appropriate model listeners. * * @param itemId the primary key of the item * @return the item that was removed * @throws PortalException if a item with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) @Override public Item deleteItem(long itemId) throws PortalException { return itemPersistence.remove(itemId); } /** * Deletes the item from the database. Also notifies the appropriate model listeners. * * @param item the item * @return the item that was removed */ @Indexable(type = IndexableType.DELETE) @Override public Item deleteItem(Item item) { return itemPersistence.remove(item); } @Override public DynamicQuery dynamicQuery() { Class<?> clazz = getClass(); return DynamicQueryFactoryUtil.forClass(Item.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 itemPersistence.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 net.indaba.lostandfound.model.impl.ItemModelImpl}. 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 itemPersistence.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 net.indaba.lostandfound.model.impl.ItemModelImpl}. 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 itemPersistence.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 itemPersistence.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 itemPersistence.countWithDynamicQuery(dynamicQuery, projection); } @Override public Item fetchItem(long itemId) { return itemPersistence.fetchByPrimaryKey(itemId); } /** * Returns the item matching the UUID and group. * * @param uuid the item's UUID * @param groupId the primary key of the group * @return the matching item, or <code>null</code> if a matching item could not be found */ @Override public Item fetchItemByUuidAndGroupId(String uuid, long groupId) { return itemPersistence.fetchByUUID_G(uuid, groupId); } /** * Returns the item with the primary key. * * @param itemId the primary key of the item * @return the item * @throws PortalException if a item with the primary key could not be found */ @Override public Item getItem(long itemId) throws PortalException { return itemPersistence.findByPrimaryKey(itemId); } @Override public ActionableDynamicQuery getActionableDynamicQuery() { ActionableDynamicQuery actionableDynamicQuery = new DefaultActionableDynamicQuery(); actionableDynamicQuery .setBaseLocalService(net.indaba.lostandfound.service.ItemLocalServiceUtil.getService()); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(Item.class); actionableDynamicQuery.setPrimaryKeyPropertyName("itemId"); return actionableDynamicQuery; } @Override public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { IndexableActionableDynamicQuery indexableActionableDynamicQuery = new IndexableActionableDynamicQuery(); indexableActionableDynamicQuery .setBaseLocalService(net.indaba.lostandfound.service.ItemLocalServiceUtil.getService()); indexableActionableDynamicQuery.setClassLoader(getClassLoader()); indexableActionableDynamicQuery.setModelClass(Item.class); indexableActionableDynamicQuery.setPrimaryKeyPropertyName("itemId"); return indexableActionableDynamicQuery; } protected void initActionableDynamicQuery(ActionableDynamicQuery actionableDynamicQuery) { actionableDynamicQuery .setBaseLocalService(net.indaba.lostandfound.service.ItemLocalServiceUtil.getService()); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(Item.class); actionableDynamicQuery.setPrimaryKeyPropertyName("itemId"); } @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<Item>() { @Override public void performAction(Item item) throws PortalException { StagedModelDataHandlerUtil.exportStagedModel(portletDataContext, item); } }); exportActionableDynamicQuery .setStagedModelType(new StagedModelType(PortalUtil.getClassNameId(Item.class.getName()))); return exportActionableDynamicQuery; } /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException { return itemLocalService.deleteItem((Item) persistedModel); } @Override public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException { return itemPersistence.findByPrimaryKey(primaryKeyObj); } /** * Returns all the items matching the UUID and company. * * @param uuid the UUID of the items * @param companyId the primary key of the company * @return the matching items, or an empty list if no matches were found */ @Override public List<Item> getItemsByUuidAndCompanyId(String uuid, long companyId) { return itemPersistence.findByUuid_C(uuid, companyId); } /** * Returns a range of items matching the UUID and company. * * @param uuid the UUID of the items * @param companyId the primary key of the company * @param start the lower bound of the range of items * @param end the upper bound of the range of items (not inclusive) * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) * @return the range of matching items, or an empty list if no matches were found */ @Override public List<Item> getItemsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<Item> orderByComparator) { return itemPersistence.findByUuid_C(uuid, companyId, start, end, orderByComparator); } /** * Returns the item matching the UUID and group. * * @param uuid the item's UUID * @param groupId the primary key of the group * @return the matching item * @throws PortalException if a matching item could not be found */ @Override public Item getItemByUuidAndGroupId(String uuid, long groupId) throws PortalException { return itemPersistence.findByUUID_G(uuid, groupId); } /** * Returns a range of all the items. * * <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 net.indaba.lostandfound.model.impl.ItemModelImpl}. 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 items * @param end the upper bound of the range of items (not inclusive) * @return the range of items */ @Override public List<Item> getItems(int start, int end) { return itemPersistence.findAll(start, end); } /** * Returns the number of items. * * @return the number of items */ @Override public int getItemsCount() { return itemPersistence.countAll(); } /** * Updates the item in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param item the item * @return the item that was updated */ @Indexable(type = IndexableType.REINDEX) @Override public Item updateItem(Item item) { return itemPersistence.update(item); } /** * Returns the item local service. * * @return the item local service */ public ItemLocalService getItemLocalService() { return itemLocalService; } /** * Sets the item local service. * * @param itemLocalService the item local service */ public void setItemLocalService(ItemLocalService itemLocalService) { this.itemLocalService = itemLocalService; } /** * Returns the item persistence. * * @return the item persistence */ public ItemPersistence getItemPersistence() { return itemPersistence; } /** * Sets the item persistence. * * @param itemPersistence the item persistence */ public void setItemPersistence(ItemPersistence itemPersistence) { this.itemPersistence = itemPersistence; } /** * Returns the l f image local service. * * @return the l f image local service */ public net.indaba.lostandfound.service.LFImageLocalService getLFImageLocalService() { return lfImageLocalService; } /** * Sets the l f image local service. * * @param lfImageLocalService the l f image local service */ public void setLFImageLocalService(net.indaba.lostandfound.service.LFImageLocalService lfImageLocalService) { this.lfImageLocalService = lfImageLocalService; } /** * Returns the l f image persistence. * * @return the l f image persistence */ public LFImagePersistence getLFImagePersistence() { return lfImagePersistence; } /** * Sets the l f image persistence. * * @param lfImagePersistence the l f image persistence */ public void setLFImagePersistence(LFImagePersistence lfImagePersistence) { this.lfImagePersistence = lfImagePersistence; } /** * 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() { Class<?> clazz = getClass(); _classLoader = clazz.getClassLoader(); PersistedModelLocalServiceRegistryUtil.register("net.indaba.lostandfound.model.Item", itemLocalService); } public void destroy() { PersistedModelLocalServiceRegistryUtil.unregister("net.indaba.lostandfound.model.Item"); } /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ @Override public String getOSGiServiceIdentifier() { return ItemLocalService.class.getName(); } @Override public Object invokeMethod(String name, String[] parameterTypes, Object[] arguments) throws Throwable { Thread currentThread = Thread.currentThread(); ClassLoader contextClassLoader = currentThread.getContextClassLoader(); if (contextClassLoader != _classLoader) { currentThread.setContextClassLoader(_classLoader); } try { return _clpInvoker.invokeMethod(name, parameterTypes, arguments); } finally { if (contextClassLoader != _classLoader) { currentThread.setContextClassLoader(contextClassLoader); } } } protected Class<?> getModelClass() { return Item.class; } protected String getModelClassName() { return Item.class.getName(); } /** * Performs a SQL query. * * @param sql the sql query */ protected void runSQL(String sql) { try { DataSource dataSource = itemPersistence.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 = net.indaba.lostandfound.service.ItemLocalService.class) protected ItemLocalService itemLocalService; @BeanReference(type = ItemPersistence.class) protected ItemPersistence itemPersistence; @BeanReference(type = net.indaba.lostandfound.service.LFImageLocalService.class) protected net.indaba.lostandfound.service.LFImageLocalService lfImageLocalService; @BeanReference(type = LFImagePersistence.class) protected LFImagePersistence lfImagePersistence; @BeanReference(type = com.liferay.counter.kernel.service.CounterLocalService.class) protected com.liferay.counter.kernel.service.CounterLocalService counterLocalService; @BeanReference(type = com.liferay.portal.kernel.service.ClassNameLocalService.class) protected com.liferay.portal.kernel.service.ClassNameLocalService classNameLocalService; @BeanReference(type = ClassNamePersistence.class) protected ClassNamePersistence classNamePersistence; @BeanReference(type = com.liferay.portal.kernel.service.ResourceLocalService.class) protected com.liferay.portal.kernel.service.ResourceLocalService resourceLocalService; @BeanReference(type = com.liferay.portal.kernel.service.UserLocalService.class) protected com.liferay.portal.kernel.service.UserLocalService userLocalService; @BeanReference(type = UserPersistence.class) protected UserPersistence userPersistence; @BeanReference(type = com.liferay.asset.kernel.service.AssetEntryLocalService.class) protected com.liferay.asset.kernel.service.AssetEntryLocalService assetEntryLocalService; @BeanReference(type = AssetEntryPersistence.class) protected AssetEntryPersistence assetEntryPersistence; @BeanReference(type = com.liferay.asset.kernel.service.AssetLinkLocalService.class) protected com.liferay.asset.kernel.service.AssetLinkLocalService assetLinkLocalService; @BeanReference(type = AssetLinkPersistence.class) protected AssetLinkPersistence assetLinkPersistence; private ClassLoader _classLoader; private ItemLocalServiceClpInvoker _clpInvoker = new ItemLocalServiceClpInvoker(); }