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.docs.guestbook.service.base; import com.liferay.docs.guestbook.model.Guestbook; import com.liferay.docs.guestbook.service.GuestbookLocalService; import com.liferay.docs.guestbook.service.persistence.GuestbookEntryPersistence; import com.liferay.docs.guestbook.service.persistence.GuestbookPersistence; 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.StagedModelDataHandler; import com.liferay.exportimport.kernel.lar.StagedModelDataHandlerRegistryUtil; import com.liferay.exportimport.kernel.lar.StagedModelDataHandlerUtil; import com.liferay.exportimport.kernel.lar.StagedModelType; import com.liferay.portal.aop.AopService; 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.Criterion; import com.liferay.portal.kernel.dao.orm.DefaultActionableDynamicQuery; import com.liferay.portal.kernel.dao.orm.Disjunction; 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.dao.orm.Property; import com.liferay.portal.kernel.dao.orm.PropertyFactoryUtil; import com.liferay.portal.kernel.dao.orm.RestrictionsFactoryUtil; 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.PersistedModelLocalService; import com.liferay.portal.kernel.transaction.Transactional; import com.liferay.portal.kernel.util.OrderByComparator; import com.liferay.portal.kernel.util.PortalUtil; import com.liferay.portal.kernel.workflow.WorkflowConstants; import java.io.Serializable; import java.util.List; import javax.sql.DataSource; import org.osgi.annotation.versioning.ProviderType; import org.osgi.service.component.annotations.Reference; /** * Provides the base implementation for the guestbook 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.docs.guestbook.service.impl.GuestbookLocalServiceImpl}. * </p> * * @author Liferay * @see com.liferay.docs.guestbook.service.impl.GuestbookLocalServiceImpl * @generated */ @ProviderType public abstract class GuestbookLocalServiceBaseImpl extends BaseLocalServiceImpl implements GuestbookLocalService, AopService, IdentifiableOSGiService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this class directly. Use <code>GuestbookLocalService</code> via injection or a <code>org.osgi.util.tracker.ServiceTracker</code> or use <code>com.liferay.docs.guestbook.service.GuestbookLocalServiceUtil</code>. */ /** * Adds the guestbook to the database. Also notifies the appropriate model listeners. * * @param guestbook the guestbook * @return the guestbook that was added */ @Indexable(type = IndexableType.REINDEX) @Override public Guestbook addGuestbook(Guestbook guestbook) { guestbook.setNew(true); return guestbookPersistence.update(guestbook); } /** * Creates a new guestbook with the primary key. Does not add the guestbook to the database. * * @param guestbookId the primary key for the new guestbook * @return the new guestbook */ @Override @Transactional(enabled = false) public Guestbook createGuestbook(long guestbookId) { return guestbookPersistence.create(guestbookId); } /** * Deletes the guestbook with the primary key from the database. Also notifies the appropriate model listeners. * * @param guestbookId the primary key of the guestbook * @return the guestbook that was removed * @throws PortalException if a guestbook with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) @Override public Guestbook deleteGuestbook(long guestbookId) throws PortalException { return guestbookPersistence.remove(guestbookId); } /** * Deletes the guestbook from the database. Also notifies the appropriate model listeners. * * @param guestbook the guestbook * @return the guestbook that was removed */ @Indexable(type = IndexableType.DELETE) @Override public Guestbook deleteGuestbook(Guestbook guestbook) { return guestbookPersistence.remove(guestbook); } @Override public DynamicQuery dynamicQuery() { Class<?> clazz = getClass(); return DynamicQueryFactoryUtil.forClass(Guestbook.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 guestbookPersistence.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 <code>com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS</code> 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 <code>com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS</code>), then the query will include the default ORDER BY logic from <code>com.liferay.docs.guestbook.model.impl.GuestbookModelImpl</code>. 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 guestbookPersistence.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 <code>com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS</code> 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 <code>com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS</code>), then the query will include the default ORDER BY logic from <code>com.liferay.docs.guestbook.model.impl.GuestbookModelImpl</code>. 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 guestbookPersistence.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 guestbookPersistence.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 guestbookPersistence.countWithDynamicQuery(dynamicQuery, projection); } @Override public Guestbook fetchGuestbook(long guestbookId) { return guestbookPersistence.fetchByPrimaryKey(guestbookId); } /** * Returns the guestbook matching the UUID and group. * * @param uuid the guestbook's UUID * @param groupId the primary key of the group * @return the matching guestbook, or <code>null</code> if a matching guestbook could not be found */ @Override public Guestbook fetchGuestbookByUuidAndGroupId(String uuid, long groupId) { return guestbookPersistence.fetchByUUID_G(uuid, groupId); } /** * Returns the guestbook with the primary key. * * @param guestbookId the primary key of the guestbook * @return the guestbook * @throws PortalException if a guestbook with the primary key could not be found */ @Override public Guestbook getGuestbook(long guestbookId) throws PortalException { return guestbookPersistence.findByPrimaryKey(guestbookId); } @Override public ActionableDynamicQuery getActionableDynamicQuery() { ActionableDynamicQuery actionableDynamicQuery = new DefaultActionableDynamicQuery(); actionableDynamicQuery.setBaseLocalService(guestbookLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(Guestbook.class); actionableDynamicQuery.setPrimaryKeyPropertyName("guestbookId"); return actionableDynamicQuery; } @Override public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { IndexableActionableDynamicQuery indexableActionableDynamicQuery = new IndexableActionableDynamicQuery(); indexableActionableDynamicQuery.setBaseLocalService(guestbookLocalService); indexableActionableDynamicQuery.setClassLoader(getClassLoader()); indexableActionableDynamicQuery.setModelClass(Guestbook.class); indexableActionableDynamicQuery.setPrimaryKeyPropertyName("guestbookId"); return indexableActionableDynamicQuery; } protected void initActionableDynamicQuery(ActionableDynamicQuery actionableDynamicQuery) { actionableDynamicQuery.setBaseLocalService(guestbookLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(Guestbook.class); actionableDynamicQuery.setPrimaryKeyPropertyName("guestbookId"); } @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) { Criterion modifiedDateCriterion = portletDataContext.getDateRangeCriteria("modifiedDate"); Criterion statusDateCriterion = portletDataContext.getDateRangeCriteria("statusDate"); if ((modifiedDateCriterion != null) && (statusDateCriterion != null)) { Disjunction disjunction = RestrictionsFactoryUtil.disjunction(); disjunction.add(modifiedDateCriterion); disjunction.add(statusDateCriterion); dynamicQuery.add(disjunction); } Property workflowStatusProperty = PropertyFactoryUtil.forName("status"); if (portletDataContext.isInitialPublication()) { dynamicQuery.add(workflowStatusProperty.ne(WorkflowConstants.STATUS_IN_TRASH)); } else { StagedModelDataHandler<?> stagedModelDataHandler = StagedModelDataHandlerRegistryUtil .getStagedModelDataHandler(Guestbook.class.getName()); dynamicQuery.add(workflowStatusProperty.in(stagedModelDataHandler.getExportableStatuses())); } } }); exportActionableDynamicQuery.setCompanyId(portletDataContext.getCompanyId()); exportActionableDynamicQuery .setPerformActionMethod(new ActionableDynamicQuery.PerformActionMethod<Guestbook>() { @Override public void performAction(Guestbook guestbook) throws PortalException { StagedModelDataHandlerUtil.exportStagedModel(portletDataContext, guestbook); } }); exportActionableDynamicQuery .setStagedModelType(new StagedModelType(PortalUtil.getClassNameId(Guestbook.class.getName()))); return exportActionableDynamicQuery; } /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException { return guestbookLocalService.deleteGuestbook((Guestbook) persistedModel); } @Override public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException { return guestbookPersistence.findByPrimaryKey(primaryKeyObj); } /** * Returns all the guestbooks matching the UUID and company. * * @param uuid the UUID of the guestbooks * @param companyId the primary key of the company * @return the matching guestbooks, or an empty list if no matches were found */ @Override public List<Guestbook> getGuestbooksByUuidAndCompanyId(String uuid, long companyId) { return guestbookPersistence.findByUuid_C(uuid, companyId); } /** * Returns a range of guestbooks matching the UUID and company. * * @param uuid the UUID of the guestbooks * @param companyId the primary key of the company * @param start the lower bound of the range of guestbooks * @param end the upper bound of the range of guestbooks (not inclusive) * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) * @return the range of matching guestbooks, or an empty list if no matches were found */ @Override public List<Guestbook> getGuestbooksByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<Guestbook> orderByComparator) { return guestbookPersistence.findByUuid_C(uuid, companyId, start, end, orderByComparator); } /** * Returns the guestbook matching the UUID and group. * * @param uuid the guestbook's UUID * @param groupId the primary key of the group * @return the matching guestbook * @throws PortalException if a matching guestbook could not be found */ @Override public Guestbook getGuestbookByUuidAndGroupId(String uuid, long groupId) throws PortalException { return guestbookPersistence.findByUUID_G(uuid, groupId); } /** * Returns a range of all the guestbooks. * * <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 <code>com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS</code> 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 <code>com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS</code>), then the query will include the default ORDER BY logic from <code>com.liferay.docs.guestbook.model.impl.GuestbookModelImpl</code>. 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 guestbooks * @param end the upper bound of the range of guestbooks (not inclusive) * @return the range of guestbooks */ @Override public List<Guestbook> getGuestbooks(int start, int end) { return guestbookPersistence.findAll(start, end); } /** * Returns the number of guestbooks. * * @return the number of guestbooks */ @Override public int getGuestbooksCount() { return guestbookPersistence.countAll(); } /** * Updates the guestbook in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param guestbook the guestbook * @return the guestbook that was updated */ @Indexable(type = IndexableType.REINDEX) @Override public Guestbook updateGuestbook(Guestbook guestbook) { return guestbookPersistence.update(guestbook); } @Override public Class<?>[] getAopInterfaces() { return new Class<?>[] { GuestbookLocalService.class, IdentifiableOSGiService.class, PersistedModelLocalService.class }; } @Override public void setAopProxy(Object aopProxy) { guestbookLocalService = (GuestbookLocalService) aopProxy; } /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ @Override public String getOSGiServiceIdentifier() { return GuestbookLocalService.class.getName(); } protected Class<?> getModelClass() { return Guestbook.class; } protected String getModelClassName() { return Guestbook.class.getName(); } /** * Performs a SQL query. * * @param sql the sql query */ protected void runSQL(String sql) { try { DataSource dataSource = guestbookPersistence.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); } } protected GuestbookLocalService guestbookLocalService; @Reference protected GuestbookPersistence guestbookPersistence; @Reference protected GuestbookEntryPersistence guestbookEntryPersistence; @Reference protected com.liferay.counter.kernel.service.CounterLocalService counterLocalService; @Reference protected com.liferay.portal.kernel.service.ClassNameLocalService classNameLocalService; @Reference protected com.liferay.portal.kernel.service.ResourceLocalService resourceLocalService; @Reference protected com.liferay.portal.kernel.service.UserLocalService userLocalService; }