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.layout.page.template.service.base; import aQute.bnd.annotation.ProviderType; import com.liferay.layout.page.template.model.LayoutPageTemplateEntry; import com.liferay.layout.page.template.service.LayoutPageTemplateEntryLocalService; import com.liferay.layout.page.template.service.persistence.LayoutPageTemplateCollectionPersistence; import com.liferay.layout.page.template.service.persistence.LayoutPageTemplateEntryPersistence; 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.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 layout page template 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.layout.page.template.service.impl.LayoutPageTemplateEntryLocalServiceImpl}. * </p> * * @author Brian Wing Shun Chan * @see com.liferay.layout.page.template.service.impl.LayoutPageTemplateEntryLocalServiceImpl * @see com.liferay.layout.page.template.service.LayoutPageTemplateEntryLocalServiceUtil * @generated */ @ProviderType public abstract class LayoutPageTemplateEntryLocalServiceBaseImpl extends BaseLocalServiceImpl implements LayoutPageTemplateEntryLocalService, IdentifiableOSGiService { /* * NOTE FOR DEVELOPERS: * * Never modify or reference this class directly. Always use {@link com.liferay.layout.page.template.service.LayoutPageTemplateEntryLocalServiceUtil} to access the layout page template entry local service. */ /** * Adds the layout page template entry to the database. Also notifies the appropriate model listeners. * * @param layoutPageTemplateEntry the layout page template entry * @return the layout page template entry that was added */ @Indexable(type = IndexableType.REINDEX) @Override public LayoutPageTemplateEntry addLayoutPageTemplateEntry(LayoutPageTemplateEntry layoutPageTemplateEntry) { layoutPageTemplateEntry.setNew(true); return layoutPageTemplateEntryPersistence.update(layoutPageTemplateEntry); } /** * Creates a new layout page template entry with the primary key. Does not add the layout page template entry to the database. * * @param layoutPageTemplateEntryId the primary key for the new layout page template entry * @return the new layout page template entry */ @Override public LayoutPageTemplateEntry createLayoutPageTemplateEntry(long layoutPageTemplateEntryId) { return layoutPageTemplateEntryPersistence.create(layoutPageTemplateEntryId); } /** * Deletes the layout page template entry with the primary key from the database. Also notifies the appropriate model listeners. * * @param layoutPageTemplateEntryId the primary key of the layout page template entry * @return the layout page template entry that was removed * @throws PortalException if a layout page template entry with the primary key could not be found */ @Indexable(type = IndexableType.DELETE) @Override public LayoutPageTemplateEntry deleteLayoutPageTemplateEntry(long layoutPageTemplateEntryId) throws PortalException { return layoutPageTemplateEntryPersistence.remove(layoutPageTemplateEntryId); } /** * Deletes the layout page template entry from the database. Also notifies the appropriate model listeners. * * @param layoutPageTemplateEntry the layout page template entry * @return the layout page template entry that was removed * @throws PortalException */ @Indexable(type = IndexableType.DELETE) @Override public LayoutPageTemplateEntry deleteLayoutPageTemplateEntry(LayoutPageTemplateEntry layoutPageTemplateEntry) throws PortalException { return layoutPageTemplateEntryPersistence.remove(layoutPageTemplateEntry); } @Override public DynamicQuery dynamicQuery() { Class<?> clazz = getClass(); return DynamicQueryFactoryUtil.forClass(LayoutPageTemplateEntry.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 layoutPageTemplateEntryPersistence.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.layout.page.template.model.impl.LayoutPageTemplateEntryModelImpl}. 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 layoutPageTemplateEntryPersistence.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.layout.page.template.model.impl.LayoutPageTemplateEntryModelImpl}. 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 layoutPageTemplateEntryPersistence.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 layoutPageTemplateEntryPersistence.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 layoutPageTemplateEntryPersistence.countWithDynamicQuery(dynamicQuery, projection); } @Override public LayoutPageTemplateEntry fetchLayoutPageTemplateEntry(long layoutPageTemplateEntryId) { return layoutPageTemplateEntryPersistence.fetchByPrimaryKey(layoutPageTemplateEntryId); } /** * Returns the layout page template entry with the primary key. * * @param layoutPageTemplateEntryId the primary key of the layout page template entry * @return the layout page template entry * @throws PortalException if a layout page template entry with the primary key could not be found */ @Override public LayoutPageTemplateEntry getLayoutPageTemplateEntry(long layoutPageTemplateEntryId) throws PortalException { return layoutPageTemplateEntryPersistence.findByPrimaryKey(layoutPageTemplateEntryId); } @Override public ActionableDynamicQuery getActionableDynamicQuery() { ActionableDynamicQuery actionableDynamicQuery = new DefaultActionableDynamicQuery(); actionableDynamicQuery.setBaseLocalService(layoutPageTemplateEntryLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(LayoutPageTemplateEntry.class); actionableDynamicQuery.setPrimaryKeyPropertyName("layoutPageTemplateEntryId"); return actionableDynamicQuery; } @Override public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { IndexableActionableDynamicQuery indexableActionableDynamicQuery = new IndexableActionableDynamicQuery(); indexableActionableDynamicQuery.setBaseLocalService(layoutPageTemplateEntryLocalService); indexableActionableDynamicQuery.setClassLoader(getClassLoader()); indexableActionableDynamicQuery.setModelClass(LayoutPageTemplateEntry.class); indexableActionableDynamicQuery.setPrimaryKeyPropertyName("layoutPageTemplateEntryId"); return indexableActionableDynamicQuery; } protected void initActionableDynamicQuery(ActionableDynamicQuery actionableDynamicQuery) { actionableDynamicQuery.setBaseLocalService(layoutPageTemplateEntryLocalService); actionableDynamicQuery.setClassLoader(getClassLoader()); actionableDynamicQuery.setModelClass(LayoutPageTemplateEntry.class); actionableDynamicQuery.setPrimaryKeyPropertyName("layoutPageTemplateEntryId"); } /** * @throws PortalException */ @Override public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException { return layoutPageTemplateEntryLocalService .deleteLayoutPageTemplateEntry((LayoutPageTemplateEntry) persistedModel); } @Override public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException { return layoutPageTemplateEntryPersistence.findByPrimaryKey(primaryKeyObj); } /** * Returns a range of all the layout page template 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.layout.page.template.model.impl.LayoutPageTemplateEntryModelImpl}. 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 layout page template entries * @param end the upper bound of the range of layout page template entries (not inclusive) * @return the range of layout page template entries */ @Override public List<LayoutPageTemplateEntry> getLayoutPageTemplateEntries(int start, int end) { return layoutPageTemplateEntryPersistence.findAll(start, end); } /** * Returns the number of layout page template entries. * * @return the number of layout page template entries */ @Override public int getLayoutPageTemplateEntriesCount() { return layoutPageTemplateEntryPersistence.countAll(); } /** * Updates the layout page template entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param layoutPageTemplateEntry the layout page template entry * @return the layout page template entry that was updated */ @Indexable(type = IndexableType.REINDEX) @Override public LayoutPageTemplateEntry updateLayoutPageTemplateEntry(LayoutPageTemplateEntry layoutPageTemplateEntry) { return layoutPageTemplateEntryPersistence.update(layoutPageTemplateEntry); } /** * Returns the layout page template entry local service. * * @return the layout page template entry local service */ public LayoutPageTemplateEntryLocalService getLayoutPageTemplateEntryLocalService() { return layoutPageTemplateEntryLocalService; } /** * Sets the layout page template entry local service. * * @param layoutPageTemplateEntryLocalService the layout page template entry local service */ public void setLayoutPageTemplateEntryLocalService( LayoutPageTemplateEntryLocalService layoutPageTemplateEntryLocalService) { this.layoutPageTemplateEntryLocalService = layoutPageTemplateEntryLocalService; } /** * Returns the layout page template entry persistence. * * @return the layout page template entry persistence */ public LayoutPageTemplateEntryPersistence getLayoutPageTemplateEntryPersistence() { return layoutPageTemplateEntryPersistence; } /** * Sets the layout page template entry persistence. * * @param layoutPageTemplateEntryPersistence the layout page template entry persistence */ public void setLayoutPageTemplateEntryPersistence( LayoutPageTemplateEntryPersistence layoutPageTemplateEntryPersistence) { this.layoutPageTemplateEntryPersistence = layoutPageTemplateEntryPersistence; } /** * 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 layout page template collection local service. * * @return the layout page template collection local service */ public com.liferay.layout.page.template.service.LayoutPageTemplateCollectionLocalService getLayoutPageTemplateCollectionLocalService() { return layoutPageTemplateCollectionLocalService; } /** * Sets the layout page template collection local service. * * @param layoutPageTemplateCollectionLocalService the layout page template collection local service */ public void setLayoutPageTemplateCollectionLocalService( com.liferay.layout.page.template.service.LayoutPageTemplateCollectionLocalService layoutPageTemplateCollectionLocalService) { this.layoutPageTemplateCollectionLocalService = layoutPageTemplateCollectionLocalService; } /** * Returns the layout page template collection persistence. * * @return the layout page template collection persistence */ public LayoutPageTemplateCollectionPersistence getLayoutPageTemplateCollectionPersistence() { return layoutPageTemplateCollectionPersistence; } /** * Sets the layout page template collection persistence. * * @param layoutPageTemplateCollectionPersistence the layout page template collection persistence */ public void setLayoutPageTemplateCollectionPersistence( LayoutPageTemplateCollectionPersistence layoutPageTemplateCollectionPersistence) { this.layoutPageTemplateCollectionPersistence = layoutPageTemplateCollectionPersistence; } /** * 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.layout.page.template.model.LayoutPageTemplateEntry", layoutPageTemplateEntryLocalService); } public void destroy() { persistedModelLocalServiceRegistry .unregister("com.liferay.layout.page.template.model.LayoutPageTemplateEntry"); } /** * Returns the OSGi service identifier. * * @return the OSGi service identifier */ @Override public String getOSGiServiceIdentifier() { return LayoutPageTemplateEntryLocalService.class.getName(); } protected Class<?> getModelClass() { return LayoutPageTemplateEntry.class; } protected String getModelClassName() { return LayoutPageTemplateEntry.class.getName(); } /** * Performs a SQL query. * * @param sql the sql query */ protected void runSQL(String sql) { try { DataSource dataSource = layoutPageTemplateEntryPersistence.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 = LayoutPageTemplateEntryLocalService.class) protected LayoutPageTemplateEntryLocalService layoutPageTemplateEntryLocalService; @BeanReference(type = LayoutPageTemplateEntryPersistence.class) protected LayoutPageTemplateEntryPersistence layoutPageTemplateEntryPersistence; @ServiceReference(type = com.liferay.counter.kernel.service.CounterLocalService.class) protected com.liferay.counter.kernel.service.CounterLocalService counterLocalService; @BeanReference(type = com.liferay.layout.page.template.service.LayoutPageTemplateCollectionLocalService.class) protected com.liferay.layout.page.template.service.LayoutPageTemplateCollectionLocalService layoutPageTemplateCollectionLocalService; @BeanReference(type = LayoutPageTemplateCollectionPersistence.class) protected LayoutPageTemplateCollectionPersistence layoutPageTemplateCollectionPersistence; @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; }