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.gs.hack.service.base; import aQute.bnd.annotation.ProviderType; import com.liferay.asset.kernel.service.persistence.AssetEntryPersistence; import com.liferay.asset.kernel.service.persistence.AssetTagPersistence; 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.gs.hack.model.Project; import com.liferay.gs.hack.service.ProjectLocalService; import com.liferay.gs.hack.service.persistence.ProjectPersistence; import com.liferay.gs.hack.service.persistence.ProjectTaskPersistence; import com.liferay.gs.hack.service.persistence.ProjectUserPersistence; 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 project 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.gs.hack.service.impl.ProjectLocalServiceImpl}. * </p> * * @author Brian Wing Shun Chan * @see com.liferay.gs.hack.service.impl.ProjectLocalServiceImpl * @see com.liferay.gs.hack.service.ProjectLocalServiceUtil * @generated */ @ProviderType public abstract class ProjectLocalServiceBaseImpl extends BaseLocalServiceImpl implements ProjectLocalService, IdentifiableOSGiService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this class directly. Always use {@link com.liferay.gs.hack.service.ProjectLocalServiceUtil} to access the project local service. */ /** * Adds the project to the database. Also notifies the appropriate model listeners. * * @param project the project * @return the project that was added */ @Indexable(type = IndexableType.REINDEX) @Override public Project addProject(Project project) { project.setNew(true); return projectPersistence.update(project); } /** * Creates a new project with the primary key. Does not add the project to the database. * * @param projectId the primary key for the new project * @return the new project */ @Override public Project createProject(long projectId) { return projectPersistence.create(projectId); } /** * Deletes the project with the primary key from the database. Also notifies the appropriate model listeners. * * @param projectId the primary key of the project * @return the project that was removed * @throws PortalException if a project with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) @Override public Project deleteProject(long projectId) throws PortalException { return projectPersistence.remove(projectId); } /** * Deletes the project from the database. Also notifies the appropriate model listeners. * * @param project the project * @return the project that was removed */ @Indexable(type = IndexableType.DELETE) @Override public Project deleteProject(Project project) { return projectPersistence.remove(project); } @Override public DynamicQuery dynamicQuery() { Class<?> clazz = getClass(); return DynamicQueryFactoryUtil.forClass(Project.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 projectPersistence.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.gs.hack.model.impl.ProjectModelImpl}. 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 projectPersistence.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.gs.hack.model.impl.ProjectModelImpl}. 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 projectPersistence.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 projectPersistence.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 projectPersistence.countWithDynamicQuery(dynamicQuery, projection); } @Override public Project fetchProject(long projectId) { return projectPersistence.fetchByPrimaryKey(projectId); } /** * Returns the project matching the UUID and group. * * @param uuid the project's UUID * @param groupId the primary key of the group * @return the matching project, or <code>null</code> if a matching project could not be found */ @Override public Project fetchProjectByUuidAndGroupId(String uuid, long groupId) { return projectPersistence.fetchByUUID_G(uuid, groupId); } /** * Returns the project with the primary key. * * @param projectId the primary key of the project * @return the project * @throws PortalException if a project with the primary key could not be found */ @Override public Project getProject(long projectId) throws PortalException { return projectPersistence.findByPrimaryKey(projectId); } @Override public ActionableDynamicQuery getActionableDynamicQuery() { ActionableDynamicQuery actionableDynamicQuery = new DefaultActionableDynamicQuery(); actionableDynamicQuery.setBaseLocalService(projectLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(Project.class); actionableDynamicQuery.setPrimaryKeyPropertyName("projectId"); return actionableDynamicQuery; } @Override public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { IndexableActionableDynamicQuery indexableActionableDynamicQuery = new IndexableActionableDynamicQuery(); indexableActionableDynamicQuery.setBaseLocalService(projectLocalService); indexableActionableDynamicQuery.setClassLoader(getClassLoader()); indexableActionableDynamicQuery.setModelClass(Project.class); indexableActionableDynamicQuery.setPrimaryKeyPropertyName("projectId"); return indexableActionableDynamicQuery; } protected void initActionableDynamicQuery(ActionableDynamicQuery actionableDynamicQuery) { actionableDynamicQuery.setBaseLocalService(projectLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(Project.class); actionableDynamicQuery.setPrimaryKeyPropertyName("projectId"); } @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<Project>() { @Override public void performAction(Project project) throws PortalException { StagedModelDataHandlerUtil.exportStagedModel(portletDataContext, project); } }); exportActionableDynamicQuery .setStagedModelType(new StagedModelType(PortalUtil.getClassNameId(Project.class.getName()))); return exportActionableDynamicQuery; } /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException { return projectLocalService.deleteProject((Project) persistedModel); } @Override public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException { return projectPersistence.findByPrimaryKey(primaryKeyObj); } /** * Returns all the projects matching the UUID and company. * * @param uuid the UUID of the projects * @param companyId the primary key of the company * @return the matching projects, or an empty list if no matches were found */ @Override public List<Project> getProjectsByUuidAndCompanyId(String uuid, long companyId) { return projectPersistence.findByUuid_C(uuid, companyId); } /** * Returns a range of projects matching the UUID and company. * * @param uuid the UUID of the projects * @param companyId the primary key of the company * @param start the lower bound of the range of projects * @param end the upper bound of the range of projects (not inclusive) * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) * @return the range of matching projects, or an empty list if no matches were found */ @Override public List<Project> getProjectsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<Project> orderByComparator) { return projectPersistence.findByUuid_C(uuid, companyId, start, end, orderByComparator); } /** * Returns the project matching the UUID and group. * * @param uuid the project's UUID * @param groupId the primary key of the group * @return the matching project * @throws PortalException if a matching project could not be found */ @Override public Project getProjectByUuidAndGroupId(String uuid, long groupId) throws PortalException { return projectPersistence.findByUUID_G(uuid, groupId); } /** * Returns a range of all the projects. * * <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.gs.hack.model.impl.ProjectModelImpl}. 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 projects * @param end the upper bound of the range of projects (not inclusive) * @return the range of projects */ @Override public List<Project> getProjects(int start, int end) { return projectPersistence.findAll(start, end); } /** * Returns the number of projects. * * @return the number of projects */ @Override public int getProjectsCount() { return projectPersistence.countAll(); } /** * Updates the project in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param project the project * @return the project that was updated */ @Indexable(type = IndexableType.REINDEX) @Override public Project updateProject(Project project) { return projectPersistence.update(project); } /** * Returns the project local service. * * @return the project local service */ public ProjectLocalService getProjectLocalService() { return projectLocalService; } /** * Sets the project local service. * * @param projectLocalService the project local service */ public void setProjectLocalService(ProjectLocalService projectLocalService) { this.projectLocalService = projectLocalService; } /** * Returns the project persistence. * * @return the project persistence */ public ProjectPersistence getProjectPersistence() { return projectPersistence; } /** * Sets the project persistence. * * @param projectPersistence the project persistence */ public void setProjectPersistence(ProjectPersistence projectPersistence) { this.projectPersistence = projectPersistence; } /** * Returns the project task local service. * * @return the project task local service */ public com.liferay.gs.hack.service.ProjectTaskLocalService getProjectTaskLocalService() { return projectTaskLocalService; } /** * Sets the project task local service. * * @param projectTaskLocalService the project task local service */ public void setProjectTaskLocalService( com.liferay.gs.hack.service.ProjectTaskLocalService projectTaskLocalService) { this.projectTaskLocalService = projectTaskLocalService; } /** * Returns the project task persistence. * * @return the project task persistence */ public ProjectTaskPersistence getProjectTaskPersistence() { return projectTaskPersistence; } /** * Sets the project task persistence. * * @param projectTaskPersistence the project task persistence */ public void setProjectTaskPersistence(ProjectTaskPersistence projectTaskPersistence) { this.projectTaskPersistence = projectTaskPersistence; } /** * Returns the project user local service. * * @return the project user local service */ public com.liferay.gs.hack.service.ProjectUserLocalService getProjectUserLocalService() { return projectUserLocalService; } /** * Sets the project user local service. * * @param projectUserLocalService the project user local service */ public void setProjectUserLocalService( com.liferay.gs.hack.service.ProjectUserLocalService projectUserLocalService) { this.projectUserLocalService = projectUserLocalService; } /** * Returns the project user persistence. * * @return the project user persistence */ public ProjectUserPersistence getProjectUserPersistence() { return projectUserPersistence; } /** * Sets the project user persistence. * * @param projectUserPersistence the project user persistence */ public void setProjectUserPersistence(ProjectUserPersistence projectUserPersistence) { this.projectUserPersistence = projectUserPersistence; } /** * 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 tag local service. * * @return the asset tag local service */ public com.liferay.asset.kernel.service.AssetTagLocalService getAssetTagLocalService() { return assetTagLocalService; } /** * Sets the asset tag local service. * * @param assetTagLocalService the asset tag local service */ public void setAssetTagLocalService( com.liferay.asset.kernel.service.AssetTagLocalService assetTagLocalService) { this.assetTagLocalService = assetTagLocalService; } /** * Returns the asset tag persistence. * * @return the asset tag persistence */ public AssetTagPersistence getAssetTagPersistence() { return assetTagPersistence; } /** * Sets the asset tag persistence. * * @param assetTagPersistence the asset tag persistence */ public void setAssetTagPersistence(AssetTagPersistence assetTagPersistence) { this.assetTagPersistence = assetTagPersistence; } public void afterPropertiesSet() { persistedModelLocalServiceRegistry.register("com.liferay.gs.hack.model.Project", projectLocalService); } public void destroy() { persistedModelLocalServiceRegistry.unregister("com.liferay.gs.hack.model.Project"); } /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ @Override public String getOSGiServiceIdentifier() { return ProjectLocalService.class.getName(); } protected Class<?> getModelClass() { return Project.class; } protected String getModelClassName() { return Project.class.getName(); } /** * Performs a SQL query. * * @param sql the sql query */ protected void runSQL(String sql) { try { DataSource dataSource = projectPersistence.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 = ProjectLocalService.class) protected ProjectLocalService projectLocalService; @BeanReference(type = ProjectPersistence.class) protected ProjectPersistence projectPersistence; @BeanReference(type = com.liferay.gs.hack.service.ProjectTaskLocalService.class) protected com.liferay.gs.hack.service.ProjectTaskLocalService projectTaskLocalService; @BeanReference(type = ProjectTaskPersistence.class) protected ProjectTaskPersistence projectTaskPersistence; @BeanReference(type = com.liferay.gs.hack.service.ProjectUserLocalService.class) protected com.liferay.gs.hack.service.ProjectUserLocalService projectUserLocalService; @BeanReference(type = ProjectUserPersistence.class) protected ProjectUserPersistence projectUserPersistence; @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.AssetTagLocalService.class) protected com.liferay.asset.kernel.service.AssetTagLocalService assetTagLocalService; @ServiceReference(type = AssetTagPersistence.class) protected AssetTagPersistence assetTagPersistence; @ServiceReference(type = PersistedModelLocalServiceRegistry.class) protected PersistedModelLocalServiceRegistry persistedModelLocalServiceRegistry; }