001 /** 002 * Copyright (c) 2000-2012 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 property 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 AssetTagPropertyLocalServiceUtil 034 * @see com.liferay.portlet.asset.service.base.AssetTagPropertyLocalServiceBaseImpl 035 * @see com.liferay.portlet.asset.service.impl.AssetTagPropertyLocalServiceImpl 036 * @generated 037 */ 038 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 039 PortalException.class, SystemException.class}) 040 public interface AssetTagPropertyLocalService extends BaseLocalService, 041 PersistedModelLocalService { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * Never modify or reference this interface directly. Always use {@link AssetTagPropertyLocalServiceUtil} to access the asset tag property local service. Add custom service methods to {@link com.liferay.portlet.asset.service.impl.AssetTagPropertyLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 046 */ 047 048 /** 049 * Adds the asset tag property to the database. Also notifies the appropriate model listeners. 050 * 051 * @param assetTagProperty the asset tag property 052 * @return the asset tag property that was added 053 * @throws SystemException if a system exception occurred 054 */ 055 public com.liferay.portlet.asset.model.AssetTagProperty addAssetTagProperty( 056 com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty) 057 throws com.liferay.portal.kernel.exception.SystemException; 058 059 /** 060 * Creates a new asset tag property with the primary key. Does not add the asset tag property to the database. 061 * 062 * @param tagPropertyId the primary key for the new asset tag property 063 * @return the new asset tag property 064 */ 065 public com.liferay.portlet.asset.model.AssetTagProperty createAssetTagProperty( 066 long tagPropertyId); 067 068 /** 069 * Deletes the asset tag property with the primary key from the database. Also notifies the appropriate model listeners. 070 * 071 * @param tagPropertyId the primary key of the asset tag property 072 * @return the asset tag property that was removed 073 * @throws PortalException if a asset tag property with the primary key could not be found 074 * @throws SystemException if a system exception occurred 075 */ 076 public com.liferay.portlet.asset.model.AssetTagProperty deleteAssetTagProperty( 077 long tagPropertyId) 078 throws com.liferay.portal.kernel.exception.PortalException, 079 com.liferay.portal.kernel.exception.SystemException; 080 081 /** 082 * Deletes the asset tag property from the database. Also notifies the appropriate model listeners. 083 * 084 * @param assetTagProperty the asset tag property 085 * @return the asset tag property that was removed 086 * @throws SystemException if a system exception occurred 087 */ 088 public com.liferay.portlet.asset.model.AssetTagProperty deleteAssetTagProperty( 089 com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty) 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.AssetTagProperty fetchAssetTagProperty( 158 long tagPropertyId) 159 throws com.liferay.portal.kernel.exception.SystemException; 160 161 /** 162 * Returns the asset tag property with the primary key. 163 * 164 * @param tagPropertyId the primary key of the asset tag property 165 * @return the asset tag property 166 * @throws PortalException if a asset tag property 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.AssetTagProperty getAssetTagProperty( 171 long tagPropertyId) 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 properties. 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 properties 189 * @param end the upper bound of the range of asset tag properties (not inclusive) 190 * @return the range of asset tag properties 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.AssetTagProperty> getAssetTagProperties( 195 int start, int end) 196 throws com.liferay.portal.kernel.exception.SystemException; 197 198 /** 199 * Returns the number of asset tag properties. 200 * 201 * @return the number of asset tag properties 202 * @throws SystemException if a system exception occurred 203 */ 204 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 205 public int getAssetTagPropertiesCount() 206 throws com.liferay.portal.kernel.exception.SystemException; 207 208 /** 209 * Updates the asset tag property in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 210 * 211 * @param assetTagProperty the asset tag property 212 * @return the asset tag property that was updated 213 * @throws SystemException if a system exception occurred 214 */ 215 public com.liferay.portlet.asset.model.AssetTagProperty updateAssetTagProperty( 216 com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty) 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 property. 235 * 236 * @param userId the primary key of the user 237 * @param tagId the primary key of the tag 238 * @param key the key to be associated to the value 239 * @param value the value to which the key will refer 240 * @return the created asset tag property 241 * @throws PortalException if a user with the primary key could not be 242 found, or if the key or value were invalid 243 * @throws SystemException if a system exception occurred 244 */ 245 public com.liferay.portlet.asset.model.AssetTagProperty addTagProperty( 246 long userId, long tagId, java.lang.String key, java.lang.String value) 247 throws com.liferay.portal.kernel.exception.PortalException, 248 com.liferay.portal.kernel.exception.SystemException; 249 250 /** 251 * Deletes the asset tag property with the specified tag ID. 252 * 253 * @param tagId the primary key of the tag 254 * @throws SystemException if a system exception occurred 255 */ 256 public void deleteTagProperties(long tagId) 257 throws com.liferay.portal.kernel.exception.SystemException; 258 259 /** 260 * Deletes the asset tag property instance. 261 * 262 * @param tagProperty the asset tag property instance 263 * @throws SystemException if a system exception occurred 264 */ 265 public void deleteTagProperty( 266 com.liferay.portlet.asset.model.AssetTagProperty tagProperty) 267 throws com.liferay.portal.kernel.exception.SystemException; 268 269 /** 270 * Deletes the asset tag property with the specified ID. 271 * 272 * @param tagPropertyId the primary key of the asset tag property instance 273 * @throws PortalException if an asset tag property with the primary key 274 could not be found 275 * @throws SystemException if a system exception occurred 276 */ 277 public void deleteTagProperty(long tagPropertyId) 278 throws com.liferay.portal.kernel.exception.PortalException, 279 com.liferay.portal.kernel.exception.SystemException; 280 281 /** 282 * Returns all the asset tag property instances. 283 * 284 * @return the asset tag property instances 285 * @throws SystemException if a system exception occurred 286 */ 287 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 288 public java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getTagProperties() 289 throws com.liferay.portal.kernel.exception.SystemException; 290 291 /** 292 * Returns all the asset tag property instances with the specified tag ID. 293 * 294 * @param tagId the primary key of the tag 295 * @return the matching asset tag properties 296 * @throws SystemException if a system exception occurred 297 */ 298 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 299 public java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getTagProperties( 300 long tagId) throws com.liferay.portal.kernel.exception.SystemException; 301 302 /** 303 * Returns the asset tag property with the specified ID. 304 * 305 * @param tagPropertyId the primary key of the asset tag property 306 * @return the matching asset tag property 307 * @throws PortalException if an asset tag property with the primary key 308 could not be found 309 * @throws SystemException if a system exception occurred 310 */ 311 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 312 public com.liferay.portlet.asset.model.AssetTagProperty getTagProperty( 313 long tagPropertyId) 314 throws com.liferay.portal.kernel.exception.PortalException, 315 com.liferay.portal.kernel.exception.SystemException; 316 317 /** 318 * Returns the asset tag property with the specified tag ID and key. 319 * 320 * @param tagId the primary key of the tag 321 * @param key the key that refers to some value 322 * @return the matching asset tag property 323 * @throws PortalException if an asset tag property with the tag ID and key 324 could not be found 325 * @throws SystemException if a system exception occurred 326 */ 327 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 328 public com.liferay.portlet.asset.model.AssetTagProperty getTagProperty( 329 long tagId, java.lang.String key) 330 throws com.liferay.portal.kernel.exception.PortalException, 331 com.liferay.portal.kernel.exception.SystemException; 332 333 /** 334 * Returns asset tag property keys with the specified group 335 * 336 * @param groupId the primary key of the group 337 * @return the matching asset tag property keys 338 * @throws SystemException if a system exception occurred 339 */ 340 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 341 public java.lang.String[] getTagPropertyKeys(long groupId) 342 throws com.liferay.portal.kernel.exception.SystemException; 343 344 /** 345 * Returns asset tag properties with the specified group and key. 346 * 347 * @param groupId the primary key of the group 348 * @param key the key that refers to some value 349 * @return the matching asset tag properties 350 * @throws SystemException if a system exception occurred 351 */ 352 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 353 public java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getTagPropertyValues( 354 long groupId, java.lang.String key) 355 throws com.liferay.portal.kernel.exception.SystemException; 356 357 /** 358 * Updates the asset tag property. 359 * 360 * @param tagPropertyId the primary key of the asset tag property 361 * @param key the new key to be associated to the value 362 * @param value the new value to which the key will refer 363 * @return the updated asset tag property 364 * @throws PortalException if an asset tag property with the primary key 365 could not be found, or if the key or value were invalid 366 * @throws SystemException if a system exception occurred 367 */ 368 public com.liferay.portlet.asset.model.AssetTagProperty updateTagProperty( 369 long tagPropertyId, java.lang.String key, java.lang.String value) 370 throws com.liferay.portal.kernel.exception.PortalException, 371 com.liferay.portal.kernel.exception.SystemException; 372 }