001 /** 002 * Copyright (c) 2000-present Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portlet.dynamicdatamapping.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.exception.PortalException; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.kernel.search.IndexableType; 022 import com.liferay.portal.kernel.transaction.Isolation; 023 import com.liferay.portal.kernel.transaction.Propagation; 024 import com.liferay.portal.kernel.transaction.Transactional; 025 import com.liferay.portal.service.BaseLocalService; 026 import com.liferay.portal.service.PersistedModelLocalService; 027 028 /** 029 * Provides the local service interface for DDMTemplateVersion. Methods of this 030 * service will not have security checks based on the propagated JAAS 031 * credentials because this service can only be accessed from within the same 032 * VM. 033 * 034 * @author Brian Wing Shun Chan 035 * @see DDMTemplateVersionLocalServiceUtil 036 * @see com.liferay.portlet.dynamicdatamapping.service.base.DDMTemplateVersionLocalServiceBaseImpl 037 * @see com.liferay.portlet.dynamicdatamapping.service.impl.DDMTemplateVersionLocalServiceImpl 038 * @generated 039 */ 040 @ProviderType 041 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 042 PortalException.class, SystemException.class}) 043 public interface DDMTemplateVersionLocalService extends BaseLocalService, 044 PersistedModelLocalService { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. Always use {@link DDMTemplateVersionLocalServiceUtil} to access the d d m template version local service. Add custom service methods to {@link com.liferay.portlet.dynamicdatamapping.service.impl.DDMTemplateVersionLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 049 */ 050 051 /** 052 * Adds the d d m template version to the database. Also notifies the appropriate model listeners. 053 * 054 * @param ddmTemplateVersion the d d m template version 055 * @return the d d m template version that was added 056 */ 057 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 058 public com.liferay.portlet.dynamicdatamapping.model.DDMTemplateVersion addDDMTemplateVersion( 059 com.liferay.portlet.dynamicdatamapping.model.DDMTemplateVersion ddmTemplateVersion); 060 061 /** 062 * Creates a new d d m template version with the primary key. Does not add the d d m template version to the database. 063 * 064 * @param templateVersionId the primary key for the new d d m template version 065 * @return the new d d m template version 066 */ 067 public com.liferay.portlet.dynamicdatamapping.model.DDMTemplateVersion createDDMTemplateVersion( 068 long templateVersionId); 069 070 /** 071 * Deletes the d d m template version from the database. Also notifies the appropriate model listeners. 072 * 073 * @param ddmTemplateVersion the d d m template version 074 * @return the d d m template version that was removed 075 */ 076 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 077 public com.liferay.portlet.dynamicdatamapping.model.DDMTemplateVersion deleteDDMTemplateVersion( 078 com.liferay.portlet.dynamicdatamapping.model.DDMTemplateVersion ddmTemplateVersion); 079 080 /** 081 * Deletes the d d m template version with the primary key from the database. Also notifies the appropriate model listeners. 082 * 083 * @param templateVersionId the primary key of the d d m template version 084 * @return the d d m template version that was removed 085 * @throws PortalException if a d d m template version with the primary key could not be found 086 */ 087 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 088 public com.liferay.portlet.dynamicdatamapping.model.DDMTemplateVersion deleteDDMTemplateVersion( 089 long templateVersionId) throws PortalException; 090 091 /** 092 * @throws PortalException 093 */ 094 @Override 095 public com.liferay.portal.model.PersistedModel deletePersistedModel( 096 com.liferay.portal.model.PersistedModel persistedModel) 097 throws PortalException; 098 099 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 100 101 /** 102 * Performs a dynamic query on the database and returns the matching rows. 103 * 104 * @param dynamicQuery the dynamic query 105 * @return the matching rows 106 */ 107 public <T> java.util.List<T> dynamicQuery( 108 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 109 110 /** 111 * Performs a dynamic query on the database and returns a range of the matching rows. 112 * 113 * <p> 114 * 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.portlet.dynamicdatamapping.model.impl.DDMTemplateVersionModelImpl}. 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. 115 * </p> 116 * 117 * @param dynamicQuery the dynamic query 118 * @param start the lower bound of the range of model instances 119 * @param end the upper bound of the range of model instances (not inclusive) 120 * @return the range of matching rows 121 */ 122 public <T> java.util.List<T> dynamicQuery( 123 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 124 int end); 125 126 /** 127 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 128 * 129 * <p> 130 * 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.portlet.dynamicdatamapping.model.impl.DDMTemplateVersionModelImpl}. 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. 131 * </p> 132 * 133 * @param dynamicQuery the dynamic query 134 * @param start the lower bound of the range of model instances 135 * @param end the upper bound of the range of model instances (not inclusive) 136 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 137 * @return the ordered range of matching rows 138 */ 139 public <T> java.util.List<T> dynamicQuery( 140 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 141 int end, 142 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 143 144 /** 145 * Returns the number of rows matching the dynamic query. 146 * 147 * @param dynamicQuery the dynamic query 148 * @return the number of rows matching the dynamic query 149 */ 150 public long dynamicQueryCount( 151 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 152 153 /** 154 * Returns the number of rows matching the dynamic query. 155 * 156 * @param dynamicQuery the dynamic query 157 * @param projection the projection to apply to the query 158 * @return the number of rows matching the dynamic query 159 */ 160 public long dynamicQueryCount( 161 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 162 com.liferay.portal.kernel.dao.orm.Projection projection); 163 164 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 165 public com.liferay.portlet.dynamicdatamapping.model.DDMTemplateVersion fetchDDMTemplateVersion( 166 long templateVersionId); 167 168 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 169 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 170 171 /** 172 * Returns the Spring bean ID for this bean. 173 * 174 * @return the Spring bean ID for this bean 175 */ 176 public java.lang.String getBeanIdentifier(); 177 178 /** 179 * Returns the d d m template version with the primary key. 180 * 181 * @param templateVersionId the primary key of the d d m template version 182 * @return the d d m template version 183 * @throws PortalException if a d d m template version with the primary key could not be found 184 */ 185 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 186 public com.liferay.portlet.dynamicdatamapping.model.DDMTemplateVersion getDDMTemplateVersion( 187 long templateVersionId) throws PortalException; 188 189 /** 190 * Returns a range of all the d d m template versions. 191 * 192 * <p> 193 * 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.portlet.dynamicdatamapping.model.impl.DDMTemplateVersionModelImpl}. 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. 194 * </p> 195 * 196 * @param start the lower bound of the range of d d m template versions 197 * @param end the upper bound of the range of d d m template versions (not inclusive) 198 * @return the range of d d m template versions 199 */ 200 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 201 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplateVersion> getDDMTemplateVersions( 202 int start, int end); 203 204 /** 205 * Returns the number of d d m template versions. 206 * 207 * @return the number of d d m template versions 208 */ 209 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 210 public int getDDMTemplateVersionsCount(); 211 212 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 213 public com.liferay.portlet.dynamicdatamapping.model.DDMTemplateVersion getLatestTemplateVersion( 214 long templateId) throws PortalException; 215 216 @Override 217 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 218 public com.liferay.portal.model.PersistedModel getPersistedModel( 219 java.io.Serializable primaryKeyObj) throws PortalException; 220 221 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 222 public com.liferay.portlet.dynamicdatamapping.model.DDMTemplateVersion getTemplateVersion( 223 long templateId, java.lang.String version) throws PortalException; 224 225 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 226 public com.liferay.portlet.dynamicdatamapping.model.DDMTemplateVersion getTemplateVersion( 227 long templateVersionId) throws PortalException; 228 229 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 230 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMTemplateVersion> getTemplateVersions( 231 long templateId, int start, int end, 232 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.dynamicdatamapping.model.DDMTemplateVersion> orderByComparator); 233 234 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 235 public int getTemplateVersionsCount(long templateId); 236 237 /** 238 * Sets the Spring bean ID for this bean. 239 * 240 * @param beanIdentifier the Spring bean ID for this bean 241 */ 242 public void setBeanIdentifier(java.lang.String beanIdentifier); 243 244 /** 245 * Updates the d d m template version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 246 * 247 * @param ddmTemplateVersion the d d m template version 248 * @return the d d m template version that was updated 249 */ 250 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 251 public com.liferay.portlet.dynamicdatamapping.model.DDMTemplateVersion updateDDMTemplateVersion( 252 com.liferay.portlet.dynamicdatamapping.model.DDMTemplateVersion ddmTemplateVersion); 253 }