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