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.GuestbookEntry; import com.liferay.docs.guestbook.service.GuestbookEntryLocalService; 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 entry 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.GuestbookEntryLocalServiceImpl}. * </p> * * @author Liferay * @see com.liferay.docs.guestbook.service.impl.GuestbookEntryLocalServiceImpl * @generated */ @ProviderType public abstract class GuestbookEntryLocalServiceBaseImpl extends BaseLocalServiceImpl implements GuestbookEntryLocalService, AopService, IdentifiableOSGiService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this class directly. Use <code>GuestbookEntryLocalService</code> via injection or a <code>org.osgi.util.tracker.ServiceTracker</code> or use <code>com.liferay.docs.guestbook.service.GuestbookEntryLocalServiceUtil</code>. */ /** * Adds the guestbook entry to the database. Also notifies the appropriate model listeners. * * @param guestbookEntry the guestbook entry * @return the guestbook entry that was added */ @Indexable(type = IndexableType.REINDEX) @Override public GuestbookEntry addGuestbookEntry(GuestbookEntry guestbookEntry) { guestbookEntry.setNew(true); return guestbookEntryPersistence.update(guestbookEntry); } /** * Creates a new guestbook entry with the primary key. Does not add the guestbook entry to the database. * * @param entryId the primary key for the new guestbook entry * @return the new guestbook entry */ @Override @Transactional(enabled = false) public GuestbookEntry createGuestbookEntry(long entryId) { return guestbookEntryPersistence.create(entryId); } /** * Deletes the guestbook entry with the primary key from the database. Also notifies the appropriate model listeners. * * @param entryId the primary key of the guestbook entry * @return the guestbook entry that was removed * @throws PortalException if a guestbook entry with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) @Override public GuestbookEntry deleteGuestbookEntry(long entryId) throws PortalException { return guestbookEntryPersistence.remove(entryId); } /** * Deletes the guestbook entry from the database. Also notifies the appropriate model listeners. * * @param guestbookEntry the guestbook entry * @return the guestbook entry that was removed * @throws PortalException */ @Indexable(type = IndexableType.DELETE) @Override public GuestbookEntry deleteGuestbookEntry(GuestbookEntry guestbookEntry) throws PortalException { return guestbookEntryPersistence.remove(guestbookEntry); } @Override public DynamicQuery dynamicQuery() { Class<?> clazz = getClass(); return DynamicQueryFactoryUtil.forClass(GuestbookEntry.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 guestbookEntryPersistence.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.GuestbookEntryModelImpl</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 guestbookEntryPersistence.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.GuestbookEntryModelImpl</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 guestbookEntryPersistence.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 guestbookEntryPersistence.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 guestbookEntryPersistence.countWithDynamicQuery(dynamicQuery, projection); } @Override public GuestbookEntry fetchGuestbookEntry(long entryId) { return guestbookEntryPersistence.fetchByPrimaryKey(entryId); } /** * Returns the guestbook entry matching the UUID and group. * * @param uuid the guestbook entry's UUID * @param groupId the primary key of the group * @return the matching guestbook entry, or <code>null</code> if a matching guestbook entry could not be found */ @Override public GuestbookEntry fetchGuestbookEntryByUuidAndGroupId(String uuid, long groupId) { return guestbookEntryPersistence.fetchByUUID_G(uuid, groupId); } /** * Returns the guestbook entry with the primary key. * * @param entryId the primary key of the guestbook entry * @return the guestbook entry * @throws PortalException if a guestbook entry with the primary key could not be found */ @Override public GuestbookEntry getGuestbookEntry(long entryId) throws PortalException { return guestbookEntryPersistence.findByPrimaryKey(entryId); } @Override public ActionableDynamicQuery getActionableDynamicQuery() { ActionableDynamicQuery actionableDynamicQuery = new DefaultActionableDynamicQuery(); actionableDynamicQuery.setBaseLocalService(guestbookEntryLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(GuestbookEntry.class); actionableDynamicQuery.setPrimaryKeyPropertyName("entryId"); return actionableDynamicQuery; } @Override public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { IndexableActionableDynamicQuery indexableActionableDynamicQuery = new IndexableActionableDynamicQuery(); indexableActionableDynamicQuery.setBaseLocalService(guestbookEntryLocalService); indexableActionableDynamicQuery.setClassLoader(getClassLoader()); indexableActionableDynamicQuery.setModelClass(GuestbookEntry.class); indexableActionableDynamicQuery.setPrimaryKeyPropertyName("entryId"); return indexableActionableDynamicQuery; } protected void initActionableDynamicQuery(ActionableDynamicQuery actionableDynamicQuery) { actionableDynamicQuery.setBaseLocalService(guestbookEntryLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(GuestbookEntry.class); actionableDynamicQuery.setPrimaryKeyPropertyName("entryId"); } @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(GuestbookEntry.class.getName()); dynamicQuery.add(workflowStatusProperty.in(stagedModelDataHandler.getExportableStatuses())); } } }); exportActionableDynamicQuery.setCompanyId(portletDataContext.getCompanyId()); exportActionableDynamicQuery .setPerformActionMethod(new ActionableDynamicQuery.PerformActionMethod<GuestbookEntry>() { @Override public void performAction(GuestbookEntry guestbookEntry) throws PortalException { StagedModelDataHandlerUtil.exportStagedModel(portletDataContext, guestbookEntry); } }); exportActionableDynamicQuery .setStagedModelType(new StagedModelType(PortalUtil.getClassNameId(GuestbookEntry.class.getName()))); return exportActionableDynamicQuery; } /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException { return guestbookEntryLocalService.deleteGuestbookEntry((GuestbookEntry) persistedModel); } @Override public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException { return guestbookEntryPersistence.findByPrimaryKey(primaryKeyObj); } /** * Returns all the guestbook entries matching the UUID and company. * * @param uuid the UUID of the guestbook entries * @param companyId the primary key of the company * @return the matching guestbook entries, or an empty list if no matches were found */ @Override public List<GuestbookEntry> getGuestbookEntriesByUuidAndCompanyId(String uuid, long companyId) { return guestbookEntryPersistence.findByUuid_C(uuid, companyId); } /** * Returns a range of guestbook entries matching the UUID and company. * * @param uuid the UUID of the guestbook entries * @param companyId the primary key of the company * @param start the lower bound of the range of guestbook entries * @param end the upper bound of the range of guestbook entries (not inclusive) * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) * @return the range of matching guestbook entries, or an empty list if no matches were found */ @Override public List<GuestbookEntry> getGuestbookEntriesByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<GuestbookEntry> orderByComparator) { return guestbookEntryPersistence.findByUuid_C(uuid, companyId, start, end, orderByComparator); } /** * Returns the guestbook entry matching the UUID and group. * * @param uuid the guestbook entry's UUID * @param groupId the primary key of the group * @return the matching guestbook entry * @throws PortalException if a matching guestbook entry could not be found */ @Override public GuestbookEntry getGuestbookEntryByUuidAndGroupId(String uuid, long groupId) throws PortalException { return guestbookEntryPersistence.findByUUID_G(uuid, groupId); } /** * Returns a range of all the guestbook entries. * * <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.GuestbookEntryModelImpl</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 guestbook entries * @param end the upper bound of the range of guestbook entries (not inclusive) * @return the range of guestbook entries */ @Override public List<GuestbookEntry> getGuestbookEntries(int start, int end) { return guestbookEntryPersistence.findAll(start, end); } /** * Returns the number of guestbook entries. * * @return the number of guestbook entries */ @Override public int getGuestbookEntriesCount() { return guestbookEntryPersistence.countAll(); } /** * Updates the guestbook entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param guestbookEntry the guestbook entry * @return the guestbook entry that was updated */ @Indexable(type = IndexableType.REINDEX) @Override public GuestbookEntry updateGuestbookEntry(GuestbookEntry guestbookEntry) { return guestbookEntryPersistence.update(guestbookEntry); } @Override public Class<?>[] getAopInterfaces() { return new Class<?>[] { GuestbookEntryLocalService.class, IdentifiableOSGiService.class, PersistedModelLocalService.class }; } @Override public void setAopProxy(Object aopProxy) { guestbookEntryLocalService = (GuestbookEntryLocalService) aopProxy; } /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ @Override public String getOSGiServiceIdentifier() { return GuestbookEntryLocalService.class.getName(); } protected Class<?> getModelClass() { return GuestbookEntry.class; } protected String getModelClassName() { return GuestbookEntry.class.getName(); } /** * Performs a SQL query. * * @param sql the sql query */ protected void runSQL(String sql) { try { DataSource dataSource = guestbookEntryPersistence.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); } } @Reference protected GuestbookPersistence guestbookPersistence; protected GuestbookEntryLocalService guestbookEntryLocalService; @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; }