001 /** 002 * Copyright (c) 2000-2013 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.asset.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 AssetTagStats. 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 AssetTagStatsLocalServiceUtil 036 * @see com.liferay.portlet.asset.service.base.AssetTagStatsLocalServiceBaseImpl 037 * @see com.liferay.portlet.asset.service.impl.AssetTagStatsLocalServiceImpl 038 * @generated 039 */ 040 @ProviderType 041 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 042 PortalException.class, SystemException.class}) 043 public interface AssetTagStatsLocalService extends BaseLocalService, 044 PersistedModelLocalService { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. Always use {@link AssetTagStatsLocalServiceUtil} to access the asset tag stats local service. Add custom service methods to {@link com.liferay.portlet.asset.service.impl.AssetTagStatsLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 049 */ 050 051 /** 052 * Adds the asset tag stats to the database. Also notifies the appropriate model listeners. 053 * 054 * @param assetTagStats the asset tag stats 055 * @return the asset tag stats that was added 056 * @throws SystemException if a system exception occurred 057 */ 058 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 059 public com.liferay.portlet.asset.model.AssetTagStats addAssetTagStats( 060 com.liferay.portlet.asset.model.AssetTagStats assetTagStats) 061 throws com.liferay.portal.kernel.exception.SystemException; 062 063 /** 064 * Creates a new asset tag stats with the primary key. Does not add the asset tag stats to the database. 065 * 066 * @param tagStatsId the primary key for the new asset tag stats 067 * @return the new asset tag stats 068 */ 069 public com.liferay.portlet.asset.model.AssetTagStats createAssetTagStats( 070 long tagStatsId); 071 072 /** 073 * Deletes the asset tag stats with the primary key from the database. Also notifies the appropriate model listeners. 074 * 075 * @param tagStatsId the primary key of the asset tag stats 076 * @return the asset tag stats that was removed 077 * @throws PortalException if a asset tag stats with the primary key could not be found 078 * @throws SystemException if a system exception occurred 079 */ 080 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 081 public com.liferay.portlet.asset.model.AssetTagStats deleteAssetTagStats( 082 long tagStatsId) 083 throws com.liferay.portal.kernel.exception.PortalException, 084 com.liferay.portal.kernel.exception.SystemException; 085 086 /** 087 * Deletes the asset tag stats from the database. Also notifies the appropriate model listeners. 088 * 089 * @param assetTagStats the asset tag stats 090 * @return the asset tag stats that was removed 091 * @throws SystemException if a system exception occurred 092 */ 093 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 094 public com.liferay.portlet.asset.model.AssetTagStats deleteAssetTagStats( 095 com.liferay.portlet.asset.model.AssetTagStats assetTagStats) 096 throws com.liferay.portal.kernel.exception.SystemException; 097 098 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 099 100 /** 101 * Performs a dynamic query on the database and returns the matching rows. 102 * 103 * @param dynamicQuery the dynamic query 104 * @return the matching rows 105 * @throws SystemException if a system exception occurred 106 */ 107 @SuppressWarnings("rawtypes") 108 public java.util.List dynamicQuery( 109 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 110 throws com.liferay.portal.kernel.exception.SystemException; 111 112 /** 113 * Performs a dynamic query on the database and returns a range of the matching rows. 114 * 115 * <p> 116 * 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.asset.model.impl.AssetTagStatsModelImpl}. 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. 117 * </p> 118 * 119 * @param dynamicQuery the dynamic query 120 * @param start the lower bound of the range of model instances 121 * @param end the upper bound of the range of model instances (not inclusive) 122 * @return the range of matching rows 123 * @throws SystemException if a system exception occurred 124 */ 125 @SuppressWarnings("rawtypes") 126 public java.util.List dynamicQuery( 127 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 128 int end) throws com.liferay.portal.kernel.exception.SystemException; 129 130 /** 131 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 132 * 133 * <p> 134 * 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.asset.model.impl.AssetTagStatsModelImpl}. 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. 135 * </p> 136 * 137 * @param dynamicQuery the dynamic query 138 * @param start the lower bound of the range of model instances 139 * @param end the upper bound of the range of model instances (not inclusive) 140 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 141 * @return the ordered range of matching rows 142 * @throws SystemException if a system exception occurred 143 */ 144 @SuppressWarnings("rawtypes") 145 public java.util.List dynamicQuery( 146 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 147 int end, 148 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 149 throws com.liferay.portal.kernel.exception.SystemException; 150 151 /** 152 * Returns the number of rows that match the dynamic query. 153 * 154 * @param dynamicQuery the dynamic query 155 * @return the number of rows that match the dynamic query 156 * @throws SystemException if a system exception occurred 157 */ 158 public long dynamicQueryCount( 159 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 160 throws com.liferay.portal.kernel.exception.SystemException; 161 162 /** 163 * Returns the number of rows that match the dynamic query. 164 * 165 * @param dynamicQuery the dynamic query 166 * @param projection the projection to apply to the query 167 * @return the number of rows that match the dynamic query 168 * @throws SystemException if a system exception occurred 169 */ 170 public long dynamicQueryCount( 171 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 172 com.liferay.portal.kernel.dao.orm.Projection projection) 173 throws com.liferay.portal.kernel.exception.SystemException; 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public com.liferay.portlet.asset.model.AssetTagStats fetchAssetTagStats( 177 long tagStatsId) 178 throws com.liferay.portal.kernel.exception.SystemException; 179 180 /** 181 * Returns the asset tag stats with the primary key. 182 * 183 * @param tagStatsId the primary key of the asset tag stats 184 * @return the asset tag stats 185 * @throws PortalException if a asset tag stats with the primary key could not be found 186 * @throws SystemException if a system exception occurred 187 */ 188 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 189 public com.liferay.portlet.asset.model.AssetTagStats getAssetTagStats( 190 long tagStatsId) 191 throws com.liferay.portal.kernel.exception.PortalException, 192 com.liferay.portal.kernel.exception.SystemException; 193 194 @Override 195 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 196 public com.liferay.portal.model.PersistedModel getPersistedModel( 197 java.io.Serializable primaryKeyObj) 198 throws com.liferay.portal.kernel.exception.PortalException, 199 com.liferay.portal.kernel.exception.SystemException; 200 201 /** 202 * Returns a range of all the asset tag statses. 203 * 204 * <p> 205 * 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.asset.model.impl.AssetTagStatsModelImpl}. 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. 206 * </p> 207 * 208 * @param start the lower bound of the range of asset tag statses 209 * @param end the upper bound of the range of asset tag statses (not inclusive) 210 * @return the range of asset tag statses 211 * @throws SystemException if a system exception occurred 212 */ 213 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 214 public java.util.List<com.liferay.portlet.asset.model.AssetTagStats> getAssetTagStatses( 215 int start, int end) 216 throws com.liferay.portal.kernel.exception.SystemException; 217 218 /** 219 * Returns the number of asset tag statses. 220 * 221 * @return the number of asset tag statses 222 * @throws SystemException if a system exception occurred 223 */ 224 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 225 public int getAssetTagStatsesCount() 226 throws com.liferay.portal.kernel.exception.SystemException; 227 228 /** 229 * Updates the asset tag stats in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 230 * 231 * @param assetTagStats the asset tag stats 232 * @return the asset tag stats that was updated 233 * @throws SystemException if a system exception occurred 234 */ 235 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 236 public com.liferay.portlet.asset.model.AssetTagStats updateAssetTagStats( 237 com.liferay.portlet.asset.model.AssetTagStats assetTagStats) 238 throws com.liferay.portal.kernel.exception.SystemException; 239 240 /** 241 * Returns the Spring bean ID for this bean. 242 * 243 * @return the Spring bean ID for this bean 244 */ 245 public java.lang.String getBeanIdentifier(); 246 247 /** 248 * Sets the Spring bean ID for this bean. 249 * 250 * @param beanIdentifier the Spring bean ID for this bean 251 */ 252 public void setBeanIdentifier(java.lang.String beanIdentifier); 253 254 /** 255 * Adds an asset tag statistics instance. 256 * 257 * @param tagId the primary key of the tag 258 * @param classNameId the asset entry's class name ID 259 * @return the asset tag statistics instance 260 * @throws SystemException if a system exception occurred 261 */ 262 public com.liferay.portlet.asset.model.AssetTagStats addTagStats( 263 long tagId, long classNameId) 264 throws com.liferay.portal.kernel.exception.SystemException; 265 266 /** 267 * Deletes the asset tag statistics instance. 268 * 269 * @param tagStats the asset tag statistics instance 270 * @throws SystemException if a system exception occurred 271 */ 272 public void deleteTagStats( 273 com.liferay.portlet.asset.model.AssetTagStats tagStats) 274 throws com.liferay.portal.kernel.exception.SystemException; 275 276 /** 277 * Deletes the asset tag statistics instance matching the tag statistics ID. 278 * 279 * @param tagStatsId the primary key of the asset tag statistics instance 280 * @throws PortalException if the assetTagStats with the primary key could 281 not be found 282 * @throws SystemException if a system exception occurred 283 */ 284 public void deleteTagStats(long tagStatsId) 285 throws com.liferay.portal.kernel.exception.PortalException, 286 com.liferay.portal.kernel.exception.SystemException; 287 288 /** 289 * Deletes all asset tag statistics instances associated with the asset 290 * entry matching the class name ID. 291 * 292 * @param classNameId the asset entry's class name ID 293 * @throws SystemException if a system exception occurred 294 */ 295 public void deleteTagStatsByClassNameId(long classNameId) 296 throws com.liferay.portal.kernel.exception.SystemException; 297 298 /** 299 * Deletes all asset tag statistics instances associated with the tag. 300 * 301 * @param tagId the primary key of the tag 302 * @throws SystemException if a system exception occurred 303 */ 304 public void deleteTagStatsByTagId(long tagId) 305 throws com.liferay.portal.kernel.exception.SystemException; 306 307 /** 308 * Returns a range of all the asset tag statistics instances associated with 309 * the asset entry matching the class name ID. 310 * 311 * <p> 312 * Useful when paginating results. Returns a maximum of <code>end - 313 * start</code> instances. <code>start</code> and <code>end</code> are not 314 * primary keys, they are indexes in the result set. Thus, <code>0</code> 315 * refers to the first result in the set. Setting both <code>start</code> 316 * and <code>end</code> to {@link 317 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 318 * result set. 319 * </p> 320 * 321 * @param classNameId the asset entry's class name ID 322 * @param start the lower bound of the range of results 323 * @param end the upper bound of the range of results (not inclusive) 324 * @return the range of asset tag statistics associated with the asset entry 325 matching the class name ID 326 * @throws SystemException if a system exception occurred 327 */ 328 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 329 public java.util.List<com.liferay.portlet.asset.model.AssetTagStats> getTagStats( 330 long classNameId, int start, int end) 331 throws com.liferay.portal.kernel.exception.SystemException; 332 333 /** 334 * Returns the asset tag statistics instance with the tag and asset entry 335 * matching the class name ID 336 * 337 * @param tagId the primary key of the tag 338 * @param classNameId the asset entry's class name ID 339 * @return Returns the asset tag statistics instance with the tag and asset 340 entry matching the class name ID 341 * @throws SystemException if a system exception occurred 342 */ 343 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 344 public com.liferay.portlet.asset.model.AssetTagStats getTagStats( 345 long tagId, long classNameId) 346 throws com.liferay.portal.kernel.exception.SystemException; 347 348 /** 349 * Updates the asset tag statistics instance. 350 * 351 * @param tagId the primary key of the tag 352 * @param classNameId the asset entry's class name ID 353 * @return the updated asset tag statistics instance 354 * @throws PortalException if an asset tag with the tag ID could not be 355 found 356 * @throws SystemException if a system exception occurred 357 */ 358 public com.liferay.portlet.asset.model.AssetTagStats updateTagStats( 359 long tagId, long classNameId) 360 throws com.liferay.portal.kernel.exception.PortalException, 361 com.liferay.portal.kernel.exception.SystemException; 362 }