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