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.PersistedModelLocalService; 023 024 /** 025 * The interface for the asset tag property local service. 026 * 027 * <p> 028 * 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. 029 * </p> 030 * 031 * @author Brian Wing Shun Chan 032 * @see AssetTagPropertyLocalServiceUtil 033 * @see com.liferay.portlet.asset.service.base.AssetTagPropertyLocalServiceBaseImpl 034 * @see com.liferay.portlet.asset.service.impl.AssetTagPropertyLocalServiceImpl 035 * @generated 036 */ 037 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 038 PortalException.class, SystemException.class}) 039 public interface AssetTagPropertyLocalService extends PersistedModelLocalService { 040 /* 041 * NOTE FOR DEVELOPERS: 042 * 043 * 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. 044 */ 045 046 /** 047 * Adds the asset tag property to the database. Also notifies the appropriate model listeners. 048 * 049 * @param assetTagProperty the asset tag property 050 * @return the asset tag property that was added 051 * @throws SystemException if a system exception occurred 052 */ 053 public com.liferay.portlet.asset.model.AssetTagProperty addAssetTagProperty( 054 com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty) 055 throws com.liferay.portal.kernel.exception.SystemException; 056 057 /** 058 * Creates a new asset tag property with the primary key. Does not add the asset tag property to the database. 059 * 060 * @param tagPropertyId the primary key for the new asset tag property 061 * @return the new asset tag property 062 */ 063 public com.liferay.portlet.asset.model.AssetTagProperty createAssetTagProperty( 064 long tagPropertyId); 065 066 /** 067 * Deletes the asset tag property with the primary key from the database. Also notifies the appropriate model listeners. 068 * 069 * @param tagPropertyId the primary key of the asset tag property 070 * @throws PortalException if a asset tag property with the primary key could not be found 071 * @throws SystemException if a system exception occurred 072 */ 073 public void deleteAssetTagProperty(long tagPropertyId) 074 throws com.liferay.portal.kernel.exception.PortalException, 075 com.liferay.portal.kernel.exception.SystemException; 076 077 /** 078 * Deletes the asset tag property from the database. Also notifies the appropriate model listeners. 079 * 080 * @param assetTagProperty the asset tag property 081 * @throws SystemException if a system exception occurred 082 */ 083 public void deleteAssetTagProperty( 084 com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty) 085 throws com.liferay.portal.kernel.exception.SystemException; 086 087 /** 088 * Performs a dynamic query on the database and returns the matching rows. 089 * 090 * @param dynamicQuery the dynamic query 091 * @return the matching rows 092 * @throws SystemException if a system exception occurred 093 */ 094 @SuppressWarnings("rawtypes") 095 public java.util.List dynamicQuery( 096 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 097 throws com.liferay.portal.kernel.exception.SystemException; 098 099 /** 100 * Performs a dynamic query on the database and returns a range of the matching rows. 101 * 102 * <p> 103 * 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. 104 * </p> 105 * 106 * @param dynamicQuery the dynamic query 107 * @param start the lower bound of the range of model instances 108 * @param end the upper bound of the range of model instances (not inclusive) 109 * @return the range of matching rows 110 * @throws SystemException if a system exception occurred 111 */ 112 @SuppressWarnings("rawtypes") 113 public java.util.List dynamicQuery( 114 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 115 int end) throws com.liferay.portal.kernel.exception.SystemException; 116 117 /** 118 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 119 * 120 * <p> 121 * 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. 122 * </p> 123 * 124 * @param dynamicQuery the dynamic query 125 * @param start the lower bound of the range of model instances 126 * @param end the upper bound of the range of model instances (not inclusive) 127 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 128 * @return the ordered range of matching rows 129 * @throws SystemException if a system exception occurred 130 */ 131 @SuppressWarnings("rawtypes") 132 public java.util.List dynamicQuery( 133 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 134 int end, 135 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 136 throws com.liferay.portal.kernel.exception.SystemException; 137 138 /** 139 * Returns the number of rows that match the dynamic query. 140 * 141 * @param dynamicQuery the dynamic query 142 * @return the number of rows that match the dynamic query 143 * @throws SystemException if a system exception occurred 144 */ 145 public long dynamicQueryCount( 146 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 147 throws com.liferay.portal.kernel.exception.SystemException; 148 149 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 150 public com.liferay.portlet.asset.model.AssetTagProperty fetchAssetTagProperty( 151 long tagPropertyId) 152 throws com.liferay.portal.kernel.exception.SystemException; 153 154 /** 155 * Returns the asset tag property with the primary key. 156 * 157 * @param tagPropertyId the primary key of the asset tag property 158 * @return the asset tag property 159 * @throws PortalException if a asset tag property with the primary key could not be found 160 * @throws SystemException if a system exception occurred 161 */ 162 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 163 public com.liferay.portlet.asset.model.AssetTagProperty getAssetTagProperty( 164 long tagPropertyId) 165 throws com.liferay.portal.kernel.exception.PortalException, 166 com.liferay.portal.kernel.exception.SystemException; 167 168 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 169 public com.liferay.portal.model.PersistedModel getPersistedModel( 170 java.io.Serializable primaryKeyObj) 171 throws com.liferay.portal.kernel.exception.PortalException, 172 com.liferay.portal.kernel.exception.SystemException; 173 174 /** 175 * Returns a range of all the asset tag properties. 176 * 177 * <p> 178 * 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. 179 * </p> 180 * 181 * @param start the lower bound of the range of asset tag properties 182 * @param end the upper bound of the range of asset tag properties (not inclusive) 183 * @return the range of asset tag properties 184 * @throws SystemException if a system exception occurred 185 */ 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getAssetTagProperties( 188 int start, int end) 189 throws com.liferay.portal.kernel.exception.SystemException; 190 191 /** 192 * Returns the number of asset tag properties. 193 * 194 * @return the number of asset tag properties 195 * @throws SystemException if a system exception occurred 196 */ 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public int getAssetTagPropertiesCount() 199 throws com.liferay.portal.kernel.exception.SystemException; 200 201 /** 202 * Updates the asset tag property in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 203 * 204 * @param assetTagProperty the asset tag property 205 * @return the asset tag property that was updated 206 * @throws SystemException if a system exception occurred 207 */ 208 public com.liferay.portlet.asset.model.AssetTagProperty updateAssetTagProperty( 209 com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty) 210 throws com.liferay.portal.kernel.exception.SystemException; 211 212 /** 213 * Updates the asset tag property in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 214 * 215 * @param assetTagProperty the asset tag property 216 * @param merge whether to merge the asset tag property 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. 217 * @return the asset tag property that was updated 218 * @throws SystemException if a system exception occurred 219 */ 220 public com.liferay.portlet.asset.model.AssetTagProperty updateAssetTagProperty( 221 com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty, 222 boolean merge) 223 throws com.liferay.portal.kernel.exception.SystemException; 224 225 /** 226 * Returns the Spring bean ID for this bean. 227 * 228 * @return the Spring bean ID for this bean 229 */ 230 public java.lang.String getBeanIdentifier(); 231 232 /** 233 * Sets the Spring bean ID for this bean. 234 * 235 * @param beanIdentifier the Spring bean ID for this bean 236 */ 237 public void setBeanIdentifier(java.lang.String beanIdentifier); 238 239 /** 240 * Adds an asset tag property. 241 * 242 * @param userId the primary key of the user 243 * @param tagId the primary key of the tag 244 * @param key the key to be associated to the value 245 * @param value the value to which the key will refer 246 * @return the created asset tag property 247 * @throws PortalException if a user with the primary key could not be 248 found, or if the key or value were invalid 249 * @throws SystemException if a system exception occurred 250 */ 251 public com.liferay.portlet.asset.model.AssetTagProperty addTagProperty( 252 long userId, long tagId, java.lang.String key, java.lang.String value) 253 throws com.liferay.portal.kernel.exception.PortalException, 254 com.liferay.portal.kernel.exception.SystemException; 255 256 /** 257 * Deletes the asset tag property with the specified tag ID. 258 * 259 * @param tagId the primary key of the tag 260 * @throws SystemException if a system exception occurred 261 */ 262 public void deleteTagProperties(long tagId) 263 throws com.liferay.portal.kernel.exception.SystemException; 264 265 /** 266 * Deletes the asset tag property instance. 267 * 268 * @param tagProperty the asset tag property instance 269 * @throws SystemException if a system exception occurred 270 */ 271 public void deleteTagProperty( 272 com.liferay.portlet.asset.model.AssetTagProperty tagProperty) 273 throws com.liferay.portal.kernel.exception.SystemException; 274 275 /** 276 * Deletes the asset tag property with the specified ID. 277 * 278 * @param tagPropertyId the primary key of the asset tag property instance 279 * @throws PortalException if an asset tag property with the primary key 280 could not be found 281 * @throws SystemException if a system exception occurred 282 */ 283 public void deleteTagProperty(long tagPropertyId) 284 throws com.liferay.portal.kernel.exception.PortalException, 285 com.liferay.portal.kernel.exception.SystemException; 286 287 /** 288 * Returns all the asset tag property instances. 289 * 290 * @return the asset tag property instances 291 * @throws SystemException if a system exception occurred 292 */ 293 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 294 public java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getTagProperties() 295 throws com.liferay.portal.kernel.exception.SystemException; 296 297 /** 298 * Returns all the asset tag property instances with the specified tag ID. 299 * 300 * @param tagId the primary key of the tag 301 * @return the matching asset tag properties 302 * @throws SystemException if a system exception occurred 303 */ 304 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 305 public java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getTagProperties( 306 long tagId) throws com.liferay.portal.kernel.exception.SystemException; 307 308 /** 309 * Returns the asset tag property with the specified ID. 310 * 311 * @param tagPropertyId the primary key of the asset tag property 312 * @return the matching asset tag property 313 * @throws PortalException if an asset tag property with the primary key 314 could not be found 315 * @throws SystemException if a system exception occurred 316 */ 317 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 318 public com.liferay.portlet.asset.model.AssetTagProperty getTagProperty( 319 long tagPropertyId) 320 throws com.liferay.portal.kernel.exception.PortalException, 321 com.liferay.portal.kernel.exception.SystemException; 322 323 /** 324 * Returns the asset tag property with the specified tag ID and key. 325 * 326 * @param tagId the primary key of the tag 327 * @param key the key that refers to some value 328 * @return the matching asset tag property 329 * @throws PortalException if an asset tag property with the tag ID and key 330 could not be found 331 * @throws SystemException if a system exception occurred 332 */ 333 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 334 public com.liferay.portlet.asset.model.AssetTagProperty getTagProperty( 335 long tagId, java.lang.String key) 336 throws com.liferay.portal.kernel.exception.PortalException, 337 com.liferay.portal.kernel.exception.SystemException; 338 339 /** 340 * Returns asset tag property keys with the specified group 341 * 342 * @param groupId the primary key of the group 343 * @return the matching asset tag property keys 344 * @throws SystemException if a system exception occurred 345 */ 346 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 347 public java.lang.String[] getTagPropertyKeys(long groupId) 348 throws com.liferay.portal.kernel.exception.SystemException; 349 350 /** 351 * Returns asset tag properties with the specified group and key. 352 * 353 * @param groupId the primary key of the group 354 * @param key the key that refers to some value 355 * @return the matching asset tag properties 356 * @throws SystemException if a system exception occurred 357 */ 358 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 359 public java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getTagPropertyValues( 360 long groupId, java.lang.String key) 361 throws com.liferay.portal.kernel.exception.SystemException; 362 363 /** 364 * Updates the asset tag property. 365 * 366 * @param tagPropertyId the primary key of the asset tag property 367 * @param key the new key to be associated to the value 368 * @param value the new value to which the key will refer 369 * @return the updated asset tag property 370 * @throws PortalException if an asset tag property with the primary key 371 could not be found, or if the key or value were invalid 372 * @throws SystemException if a system exception occurred 373 */ 374 public com.liferay.portlet.asset.model.AssetTagProperty updateTagProperty( 375 long tagPropertyId, java.lang.String key, java.lang.String value) 376 throws com.liferay.portal.kernel.exception.PortalException, 377 com.liferay.portal.kernel.exception.SystemException; 378 }