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. 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. 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. 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. 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. 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. 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 * Returns the Spring bean ID for this bean. 221 * 222 * @return the Spring bean ID for this bean 223 */ 224 public java.lang.String getBeanIdentifier(); 225 226 /** 227 * Sets the Spring bean ID for this bean. 228 * 229 * @param beanIdentifier the Spring bean ID for this bean 230 */ 231 public void setBeanIdentifier(java.lang.String beanIdentifier); 232 233 /** 234 * Adds an asset tag statistics instance. 235 * 236 * @param tagId the primary key of the tag 237 * @param classNameId the asset entry's class name ID 238 * @return the asset tag statistics instance 239 * @throws SystemException if a system exception occurred 240 */ 241 public com.liferay.portlet.asset.model.AssetTagStats addTagStats( 242 long tagId, long classNameId) 243 throws com.liferay.portal.kernel.exception.SystemException; 244 245 /** 246 * Deletes the asset tag statistics instance. 247 * 248 * @param tagStats the asset tag statistics instance 249 * @throws SystemException if a system exception occurred 250 */ 251 public void deleteTagStats( 252 com.liferay.portlet.asset.model.AssetTagStats tagStats) 253 throws com.liferay.portal.kernel.exception.SystemException; 254 255 /** 256 * Deletes the asset tag statistics instance matching the tag statistics ID. 257 * 258 * @param tagStatsId the primary key of the asset tag statistics instance 259 * @throws PortalException if the assetTagStats with the primary key could 260 not be found 261 * @throws SystemException if a system exception occurred 262 */ 263 public void deleteTagStats(long tagStatsId) 264 throws com.liferay.portal.kernel.exception.PortalException, 265 com.liferay.portal.kernel.exception.SystemException; 266 267 /** 268 * Deletes all asset tag statistics instances associated with the asset 269 * entry matching the class name ID. 270 * 271 * @param classNameId the asset entry's class name ID 272 * @throws SystemException if a system exception occurred 273 */ 274 public void deleteTagStatsByClassNameId(long classNameId) 275 throws com.liferay.portal.kernel.exception.SystemException; 276 277 /** 278 * Deletes all asset tag statistics instances associated with the tag. 279 * 280 * @param tagId the primary key of the tag 281 * @throws SystemException if a system exception occurred 282 */ 283 public void deleteTagStatsByTagId(long tagId) 284 throws com.liferay.portal.kernel.exception.SystemException; 285 286 /** 287 * Returns a range of all the asset tag statistics instances associated with 288 * the asset entry matching the class name ID. 289 * 290 * <p> 291 * Useful when paginating results. Returns a maximum of <code>end - 292 * start</code> instances. <code>start</code> and <code>end</code> are not 293 * primary keys, they are indexes in the result set. Thus, <code>0</code> 294 * refers to the first result in the set. Setting both <code>start</code> 295 * and <code>end</code> to {@link 296 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 297 * result set. 298 * </p> 299 * 300 * @param classNameId the asset entry's class name ID 301 * @param start the lower bound of the range of results 302 * @param end the upper bound of the range of results (not inclusive) 303 * @return the range of asset tag statistics associated with the asset entry 304 matching the class name ID 305 * @throws SystemException if a system exception occurred 306 */ 307 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 308 public java.util.List<com.liferay.portlet.asset.model.AssetTagStats> getTagStats( 309 long classNameId, int start, int end) 310 throws com.liferay.portal.kernel.exception.SystemException; 311 312 /** 313 * Returns the asset tag statistics instance with the tag and asset entry 314 * matching the class name ID 315 * 316 * @param tagId the primary key of the tag 317 * @param classNameId the asset entry's class name ID 318 * @return Returns the asset tag statistics instance with the tag and asset 319 entry matching the class name ID 320 * @throws SystemException if a system exception occurred 321 */ 322 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 323 public com.liferay.portlet.asset.model.AssetTagStats getTagStats( 324 long tagId, long classNameId) 325 throws com.liferay.portal.kernel.exception.SystemException; 326 327 /** 328 * Updates the asset tag statistics instance. 329 * 330 * @param tagId the primary key of the tag 331 * @param classNameId the asset entry's class name ID 332 * @return the updated asset tag statistics instance 333 * @throws PortalException if an asset tag with the tag ID could not be 334 found 335 * @throws SystemException if a system exception occurred 336 */ 337 public com.liferay.portlet.asset.model.AssetTagStats updateTagStats( 338 long tagId, long classNameId) 339 throws com.liferay.portal.kernel.exception.PortalException, 340 com.liferay.portal.kernel.exception.SystemException; 341 }