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.school.service.base; import aQute.bnd.annotation.ProviderType; 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.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 com.liferay.school.model.Course; import com.liferay.school.service.CourseLocalService; import com.liferay.school.service.persistence.CoursePersistence; import java.io.Serializable; import java.util.List; import javax.sql.DataSource; /** * Provides the base implementation for the course 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.school.service.impl.CourseLocalServiceImpl}. * </p> * * @author dnebinger * @see com.liferay.school.service.impl.CourseLocalServiceImpl * @see com.liferay.school.service.CourseLocalServiceUtil * @generated */ @ProviderType public abstract class CourseLocalServiceBaseImpl extends BaseLocalServiceImpl implements CourseLocalService, IdentifiableOSGiService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this class directly. Always use {@link com.liferay.school.service.CourseLocalServiceUtil} to access the course local service. */ /** * Adds the course to the database. Also notifies the appropriate model listeners. * * @param course the course * @return the course that was added */ @Indexable(type = IndexableType.REINDEX) @Override public Course addCourse(Course course) { course.setNew(true); return coursePersistence.update(course); } /** * Creates a new course with the primary key. Does not add the course to the database. * * @param courseId the primary key for the new course * @return the new course */ @Override public Course createCourse(long courseId) { return coursePersistence.create(courseId); } /** * Deletes the course with the primary key from the database. Also notifies the appropriate model listeners. * * @param courseId the primary key of the course * @return the course that was removed * @throws PortalException if a course with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) @Override public Course deleteCourse(long courseId) throws PortalException { return coursePersistence.remove(courseId); } /** * Deletes the course from the database. Also notifies the appropriate model listeners. * * @param course the course * @return the course that was removed */ @Indexable(type = IndexableType.DELETE) @Override public Course deleteCourse(Course course) { return coursePersistence.remove(course); } @Override public DynamicQuery dynamicQuery() { Class<?> clazz = getClass(); return DynamicQueryFactoryUtil.forClass(Course.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 coursePersistence.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.school.model.impl.CourseModelImpl}. 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 coursePersistence.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.school.model.impl.CourseModelImpl}. 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 coursePersistence.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 coursePersistence.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 coursePersistence.countWithDynamicQuery(dynamicQuery, projection); } @Override public Course fetchCourse(long courseId) { return coursePersistence.fetchByPrimaryKey(courseId); } /** * Returns the course with the primary key. * * @param courseId the primary key of the course * @return the course * @throws PortalException if a course with the primary key could not be found */ @Override public Course getCourse(long courseId) throws PortalException { return coursePersistence.findByPrimaryKey(courseId); } @Override public ActionableDynamicQuery getActionableDynamicQuery() { ActionableDynamicQuery actionableDynamicQuery = new DefaultActionableDynamicQuery(); actionableDynamicQuery.setBaseLocalService(courseLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(Course.class); actionableDynamicQuery.setPrimaryKeyPropertyName("courseId"); return actionableDynamicQuery; } @Override public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { IndexableActionableDynamicQuery indexableActionableDynamicQuery = new IndexableActionableDynamicQuery(); indexableActionableDynamicQuery.setBaseLocalService(courseLocalService); indexableActionableDynamicQuery.setClassLoader(getClassLoader()); indexableActionableDynamicQuery.setModelClass(Course.class); indexableActionableDynamicQuery.setPrimaryKeyPropertyName("courseId"); return indexableActionableDynamicQuery; } protected void initActionableDynamicQuery(ActionableDynamicQuery actionableDynamicQuery) { actionableDynamicQuery.setBaseLocalService(courseLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(Course.class); actionableDynamicQuery.setPrimaryKeyPropertyName("courseId"); } /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException { return courseLocalService.deleteCourse((Course) persistedModel); } @Override public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException { return coursePersistence.findByPrimaryKey(primaryKeyObj); } /** * Returns a range of all the courses. * * <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.school.model.impl.CourseModelImpl}. 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 courses * @param end the upper bound of the range of courses (not inclusive) * @return the range of courses */ @Override public List<Course> getCourses(int start, int end) { return coursePersistence.findAll(start, end); } /** * Returns the number of courses. * * @return the number of courses */ @Override public int getCoursesCount() { return coursePersistence.countAll(); } /** * Updates the course in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param course the course * @return the course that was updated */ @Indexable(type = IndexableType.REINDEX) @Override public Course updateCourse(Course course) { return coursePersistence.update(course); } /** * Returns the course local service. * * @return the course local service */ public CourseLocalService getCourseLocalService() { return courseLocalService; } /** * Sets the course local service. * * @param courseLocalService the course local service */ public void setCourseLocalService(CourseLocalService courseLocalService) { this.courseLocalService = courseLocalService; } /** * Returns the course persistence. * * @return the course persistence */ public CoursePersistence getCoursePersistence() { return coursePersistence; } /** * Sets the course persistence. * * @param coursePersistence the course persistence */ public void setCoursePersistence(CoursePersistence coursePersistence) { this.coursePersistence = coursePersistence; } /** * 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() { Class<?> clazz = getClass(); _classLoader = clazz.getClassLoader(); PersistedModelLocalServiceRegistryUtil.register("com.liferay.school.model.Course", courseLocalService); } public void destroy() { PersistedModelLocalServiceRegistryUtil.unregister("com.liferay.school.model.Course"); } /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ @Override public String getOSGiServiceIdentifier() { return CourseLocalService.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 Course.class; } protected String getModelClassName() { return Course.class.getName(); } /** * Performs a SQL query. * * @param sql the sql query */ protected void runSQL(String sql) { try { DataSource dataSource = coursePersistence.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 = CourseLocalService.class) protected CourseLocalService courseLocalService; @BeanReference(type = CoursePersistence.class) protected CoursePersistence coursePersistence; @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; private ClassLoader _classLoader; private CourseLocalServiceClpInvoker _clpInvoker = new CourseLocalServiceClpInvoker(); }