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.micro.maintainance.candidate.service.base; import aQute.bnd.annotation.ProviderType; 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.micro.maintainance.candidate.model.CandidateEntry; import com.liferay.micro.maintainance.candidate.service.CandidateEntryLocalService; import com.liferay.micro.maintainance.candidate.service.persistence.CandidateEntryPersistence; 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 candidate 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.micro.maintainance.candidate.service.impl.CandidateEntryLocalServiceImpl}. * </p> * * @author Brian Wing Shun Chan * @see com.liferay.micro.maintainance.candidate.service.impl.CandidateEntryLocalServiceImpl * @see com.liferay.micro.maintainance.candidate.service.CandidateEntryLocalServiceUtil * @generated */ @ProviderType public abstract class CandidateEntryLocalServiceBaseImpl extends BaseLocalServiceImpl implements CandidateEntryLocalService, IdentifiableOSGiService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this class directly. Always use {@link com.liferay.micro.maintainance.candidate.service.CandidateEntryLocalServiceUtil} to access the candidate entry local service. */ /** * Adds the candidate entry to the database. Also notifies the appropriate model listeners. * * @param candidateEntry the candidate entry * @return the candidate entry that was added */ @Indexable(type = IndexableType.REINDEX) @Override public CandidateEntry addCandidateEntry(CandidateEntry candidateEntry) { candidateEntry.setNew(true); return candidateEntryPersistence.update(candidateEntry); } /** * Creates a new candidate entry with the primary key. Does not add the candidate entry to the database. * * @param candidateEntryId the primary key for the new candidate entry * @return the new candidate entry */ @Override public CandidateEntry createCandidateEntry(long candidateEntryId) { return candidateEntryPersistence.create(candidateEntryId); } /** * Deletes the candidate entry with the primary key from the database. Also notifies the appropriate model listeners. * * @param candidateEntryId the primary key of the candidate entry * @return the candidate entry that was removed * @throws PortalException if a candidate entry with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) @Override public CandidateEntry deleteCandidateEntry(long candidateEntryId) throws PortalException { return candidateEntryPersistence.remove(candidateEntryId); } /** * Deletes the candidate entry from the database. Also notifies the appropriate model listeners. * * @param candidateEntry the candidate entry * @return the candidate entry that was removed */ @Indexable(type = IndexableType.DELETE) @Override public CandidateEntry deleteCandidateEntry(CandidateEntry candidateEntry) { return candidateEntryPersistence.remove(candidateEntry); } @Override public DynamicQuery dynamicQuery() { Class<?> clazz = getClass(); return DynamicQueryFactoryUtil.forClass(CandidateEntry.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 candidateEntryPersistence.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.liferay.micro.maintainance.candidate.model.impl.CandidateEntryModelImpl}. 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 candidateEntryPersistence.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.liferay.micro.maintainance.candidate.model.impl.CandidateEntryModelImpl}. 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 candidateEntryPersistence.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 candidateEntryPersistence.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 candidateEntryPersistence.countWithDynamicQuery(dynamicQuery, projection); } @Override public CandidateEntry fetchCandidateEntry(long candidateEntryId) { return candidateEntryPersistence.fetchByPrimaryKey(candidateEntryId); } /** * Returns the candidate entry matching the UUID and group. * * @param uuid the candidate entry's UUID * @param groupId the primary key of the group * @return the matching candidate entry, or <code>null</code> if a matching candidate entry could not be found */ @Override public CandidateEntry fetchCandidateEntryByUuidAndGroupId(String uuid, long groupId) { return candidateEntryPersistence.fetchByUUID_G(uuid, groupId); } /** * Returns the candidate entry with the primary key. * * @param candidateEntryId the primary key of the candidate entry * @return the candidate entry * @throws PortalException if a candidate entry with the primary key could not be found */ @Override public CandidateEntry getCandidateEntry(long candidateEntryId) throws PortalException { return candidateEntryPersistence.findByPrimaryKey(candidateEntryId); } @Override public ActionableDynamicQuery getActionableDynamicQuery() { ActionableDynamicQuery actionableDynamicQuery = new DefaultActionableDynamicQuery(); actionableDynamicQuery.setBaseLocalService(candidateEntryLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(CandidateEntry.class); actionableDynamicQuery.setPrimaryKeyPropertyName("candidateEntryId"); return actionableDynamicQuery; } @Override public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { IndexableActionableDynamicQuery indexableActionableDynamicQuery = new IndexableActionableDynamicQuery(); indexableActionableDynamicQuery.setBaseLocalService(candidateEntryLocalService); indexableActionableDynamicQuery.setClassLoader(getClassLoader()); indexableActionableDynamicQuery.setModelClass(CandidateEntry.class); indexableActionableDynamicQuery.setPrimaryKeyPropertyName("candidateEntryId"); return indexableActionableDynamicQuery; } protected void initActionableDynamicQuery(ActionableDynamicQuery actionableDynamicQuery) { actionableDynamicQuery.setBaseLocalService(candidateEntryLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(CandidateEntry.class); actionableDynamicQuery.setPrimaryKeyPropertyName("candidateEntryId"); } @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<CandidateEntry>() { @Override public void performAction(CandidateEntry candidateEntry) throws PortalException { StagedModelDataHandlerUtil.exportStagedModel(portletDataContext, candidateEntry); } }); exportActionableDynamicQuery .setStagedModelType(new StagedModelType(PortalUtil.getClassNameId(CandidateEntry.class.getName()))); return exportActionableDynamicQuery; } /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException { return candidateEntryLocalService.deleteCandidateEntry((CandidateEntry) persistedModel); } @Override public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException { return candidateEntryPersistence.findByPrimaryKey(primaryKeyObj); } /** * Returns all the candidate entries matching the UUID and company. * * @param uuid the UUID of the candidate entries * @param companyId the primary key of the company * @return the matching candidate entries, or an empty list if no matches were found */ @Override public List<CandidateEntry> getCandidateEntriesByUuidAndCompanyId(String uuid, long companyId) { return candidateEntryPersistence.findByUuid_C(uuid, companyId); } /** * Returns a range of candidate entries matching the UUID and company. * * @param uuid the UUID of the candidate entries * @param companyId the primary key of the company * @param start the lower bound of the range of candidate entries * @param end the upper bound of the range of candidate entries (not inclusive) * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) * @return the range of matching candidate entries, or an empty list if no matches were found */ @Override public List<CandidateEntry> getCandidateEntriesByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<CandidateEntry> orderByComparator) { return candidateEntryPersistence.findByUuid_C(uuid, companyId, start, end, orderByComparator); } /** * Returns the candidate entry matching the UUID and group. * * @param uuid the candidate entry's UUID * @param groupId the primary key of the group * @return the matching candidate entry * @throws PortalException if a matching candidate entry could not be found */ @Override public CandidateEntry getCandidateEntryByUuidAndGroupId(String uuid, long groupId) throws PortalException { return candidateEntryPersistence.findByUUID_G(uuid, groupId); } /** * Returns a range of all the candidate 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 {@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.liferay.micro.maintainance.candidate.model.impl.CandidateEntryModelImpl}. 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 candidate entries * @param end the upper bound of the range of candidate entries (not inclusive) * @return the range of candidate entries */ @Override public List<CandidateEntry> getCandidateEntries(int start, int end) { return candidateEntryPersistence.findAll(start, end); } /** * Returns the number of candidate entries. * * @return the number of candidate entries */ @Override public int getCandidateEntriesCount() { return candidateEntryPersistence.countAll(); } /** * Updates the candidate entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param candidateEntry the candidate entry * @return the candidate entry that was updated */ @Indexable(type = IndexableType.REINDEX) @Override public CandidateEntry updateCandidateEntry(CandidateEntry candidateEntry) { return candidateEntryPersistence.update(candidateEntry); } /** * Returns the candidate entry local service. * * @return the candidate entry local service */ public CandidateEntryLocalService getCandidateEntryLocalService() { return candidateEntryLocalService; } /** * Sets the candidate entry local service. * * @param candidateEntryLocalService the candidate entry local service */ public void setCandidateEntryLocalService(CandidateEntryLocalService candidateEntryLocalService) { this.candidateEntryLocalService = candidateEntryLocalService; } /** * Returns the candidate entry persistence. * * @return the candidate entry persistence */ public CandidateEntryPersistence getCandidateEntryPersistence() { return candidateEntryPersistence; } /** * Sets the candidate entry persistence. * * @param candidateEntryPersistence the candidate entry persistence */ public void setCandidateEntryPersistence(CandidateEntryPersistence candidateEntryPersistence) { this.candidateEntryPersistence = candidateEntryPersistence; } /** * 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; } public void afterPropertiesSet() { persistedModelLocalServiceRegistry.register("com.liferay.micro.maintainance.candidate.model.CandidateEntry", candidateEntryLocalService); } public void destroy() { persistedModelLocalServiceRegistry .unregister("com.liferay.micro.maintainance.candidate.model.CandidateEntry"); } /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ @Override public String getOSGiServiceIdentifier() { return CandidateEntryLocalService.class.getName(); } protected Class<?> getModelClass() { return CandidateEntry.class; } protected String getModelClassName() { return CandidateEntry.class.getName(); } /** * Performs a SQL query. * * @param sql the sql query */ protected void runSQL(String sql) { try { DataSource dataSource = candidateEntryPersistence.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 = CandidateEntryLocalService.class) protected CandidateEntryLocalService candidateEntryLocalService; @BeanReference(type = CandidateEntryPersistence.class) protected CandidateEntryPersistence candidateEntryPersistence; @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 = PersistedModelLocalServiceRegistry.class) protected PersistedModelLocalServiceRegistry persistedModelLocalServiceRegistry; }