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 DDMStructureVersion. 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 DDMStructureVersionLocalServiceUtil 036 * @see com.liferay.portlet.dynamicdatamapping.service.base.DDMStructureVersionLocalServiceBaseImpl 037 * @see com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureVersionLocalServiceImpl 038 * @generated 039 */ 040 @ProviderType 041 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 042 PortalException.class, SystemException.class}) 043 public interface DDMStructureVersionLocalService extends BaseLocalService, 044 PersistedModelLocalService { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. Always use {@link DDMStructureVersionLocalServiceUtil} to access the d d m structure version local service. Add custom service methods to {@link com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureVersionLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 049 */ 050 051 /** 052 * Adds the d d m structure version to the database. Also notifies the appropriate model listeners. 053 * 054 * @param ddmStructureVersion the d d m structure version 055 * @return the d d m structure version that was added 056 */ 057 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 058 public com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion addDDMStructureVersion( 059 com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion ddmStructureVersion); 060 061 /** 062 * Creates a new d d m structure version with the primary key. Does not add the d d m structure version to the database. 063 * 064 * @param structureVersionId the primary key for the new d d m structure version 065 * @return the new d d m structure version 066 */ 067 public com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion createDDMStructureVersion( 068 long structureVersionId); 069 070 /** 071 * Deletes the d d m structure version from the database. Also notifies the appropriate model listeners. 072 * 073 * @param ddmStructureVersion the d d m structure version 074 * @return the d d m structure version that was removed 075 */ 076 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 077 public com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion deleteDDMStructureVersion( 078 com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion ddmStructureVersion); 079 080 /** 081 * Deletes the d d m structure version with the primary key from the database. Also notifies the appropriate model listeners. 082 * 083 * @param structureVersionId the primary key of the d d m structure version 084 * @return the d d m structure version that was removed 085 * @throws PortalException if a d d m structure 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.DDMStructureVersion deleteDDMStructureVersion( 089 long structureVersionId) 090 throws com.liferay.portal.kernel.exception.PortalException; 091 092 /** 093 * @throws PortalException 094 */ 095 @Override 096 public com.liferay.portal.model.PersistedModel deletePersistedModel( 097 com.liferay.portal.model.PersistedModel persistedModel) 098 throws com.liferay.portal.kernel.exception.PortalException; 099 100 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 101 102 /** 103 * Performs a dynamic query on the database and returns the matching rows. 104 * 105 * @param dynamicQuery the dynamic query 106 * @return the matching rows 107 */ 108 public <T> java.util.List<T> dynamicQuery( 109 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 110 111 /** 112 * Performs a dynamic query on the database and returns a range of the matching rows. 113 * 114 * <p> 115 * 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.DDMStructureVersionModelImpl}. 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. 116 * </p> 117 * 118 * @param dynamicQuery the dynamic query 119 * @param start the lower bound of the range of model instances 120 * @param end the upper bound of the range of model instances (not inclusive) 121 * @return the range of matching rows 122 */ 123 public <T> java.util.List<T> dynamicQuery( 124 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 125 int end); 126 127 /** 128 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 129 * 130 * <p> 131 * 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.DDMStructureVersionModelImpl}. 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. 132 * </p> 133 * 134 * @param dynamicQuery the dynamic query 135 * @param start the lower bound of the range of model instances 136 * @param end the upper bound of the range of model instances (not inclusive) 137 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 138 * @return the ordered range of matching rows 139 */ 140 public <T> java.util.List<T> dynamicQuery( 141 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 142 int end, 143 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 144 145 /** 146 * Returns the number of rows matching the dynamic query. 147 * 148 * @param dynamicQuery the dynamic query 149 * @return the number of rows matching the dynamic query 150 */ 151 public long dynamicQueryCount( 152 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 153 154 /** 155 * Returns the number of rows matching the dynamic query. 156 * 157 * @param dynamicQuery the dynamic query 158 * @param projection the projection to apply to the query 159 * @return the number of rows matching the dynamic query 160 */ 161 public long dynamicQueryCount( 162 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 163 com.liferay.portal.kernel.dao.orm.Projection projection); 164 165 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 166 public com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion fetchDDMStructureVersion( 167 long structureVersionId); 168 169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 171 172 /** 173 * Returns the Spring bean ID for this bean. 174 * 175 * @return the Spring bean ID for this bean 176 */ 177 public java.lang.String getBeanIdentifier(); 178 179 /** 180 * Returns the d d m structure version with the primary key. 181 * 182 * @param structureVersionId the primary key of the d d m structure version 183 * @return the d d m structure version 184 * @throws PortalException if a d d m structure version with the primary key could not be found 185 */ 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion getDDMStructureVersion( 188 long structureVersionId) 189 throws com.liferay.portal.kernel.exception.PortalException; 190 191 /** 192 * Returns a range of all the d d m structure versions. 193 * 194 * <p> 195 * 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.DDMStructureVersionModelImpl}. 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. 196 * </p> 197 * 198 * @param start the lower bound of the range of d d m structure versions 199 * @param end the upper bound of the range of d d m structure versions (not inclusive) 200 * @return the range of d d m structure versions 201 */ 202 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 203 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion> getDDMStructureVersions( 204 int start, int end); 205 206 /** 207 * Returns the number of d d m structure versions. 208 * 209 * @return the number of d d m structure versions 210 */ 211 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 212 public int getDDMStructureVersionsCount(); 213 214 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 215 public com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion getLatestStructureVersion( 216 long structureId) 217 throws com.liferay.portal.kernel.exception.PortalException; 218 219 @Override 220 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 221 public com.liferay.portal.model.PersistedModel getPersistedModel( 222 java.io.Serializable primaryKeyObj) 223 throws com.liferay.portal.kernel.exception.PortalException; 224 225 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 226 public com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion getStructureVersion( 227 long structureId, java.lang.String version) 228 throws com.liferay.portal.kernel.exception.PortalException; 229 230 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 231 public com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion getStructureVersion( 232 long structureVersionId) 233 throws com.liferay.portal.kernel.exception.PortalException; 234 235 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 236 public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion> getStructureVersions( 237 long structureId, int start, int end, 238 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion> orderByComparator); 239 240 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 241 public int getStructureVersionsCount(long structureId); 242 243 /** 244 * Sets the Spring bean ID for this bean. 245 * 246 * @param beanIdentifier the Spring bean ID for this bean 247 */ 248 public void setBeanIdentifier(java.lang.String beanIdentifier); 249 250 /** 251 * Updates the d d m structure version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 252 * 253 * @param ddmStructureVersion the d d m structure version 254 * @return the d d m structure version that was updated 255 */ 256 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 257 public com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion updateDDMStructureVersion( 258 com.liferay.portlet.dynamicdatamapping.model.DDMStructureVersion ddmStructureVersion); 259 }