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 AssetTagProperty. 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 AssetTagPropertyLocalServiceUtil 036 * @see com.liferay.portlet.asset.service.base.AssetTagPropertyLocalServiceBaseImpl 037 * @see com.liferay.portlet.asset.service.impl.AssetTagPropertyLocalServiceImpl 038 * @generated 039 */ 040 @ProviderType 041 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 042 PortalException.class, SystemException.class}) 043 public interface AssetTagPropertyLocalService extends BaseLocalService, 044 PersistedModelLocalService { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * 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. 049 */ 050 051 /** 052 * Adds the asset tag property to the database. Also notifies the appropriate model listeners. 053 * 054 * @param assetTagProperty the asset tag property 055 * @return the asset tag property 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.AssetTagProperty addAssetTagProperty( 060 com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty) 061 throws com.liferay.portal.kernel.exception.SystemException; 062 063 /** 064 * Creates a new asset tag property with the primary key. Does not add the asset tag property to the database. 065 * 066 * @param tagPropertyId the primary key for the new asset tag property 067 * @return the new asset tag property 068 */ 069 public com.liferay.portlet.asset.model.AssetTagProperty createAssetTagProperty( 070 long tagPropertyId); 071 072 /** 073 * Deletes the asset tag property with the primary key from the database. Also notifies the appropriate model listeners. 074 * 075 * @param tagPropertyId the primary key of the asset tag property 076 * @return the asset tag property that was removed 077 * @throws PortalException if a asset tag property 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.AssetTagProperty deleteAssetTagProperty( 082 long tagPropertyId) 083 throws com.liferay.portal.kernel.exception.PortalException, 084 com.liferay.portal.kernel.exception.SystemException; 085 086 /** 087 * Deletes the asset tag property from the database. Also notifies the appropriate model listeners. 088 * 089 * @param assetTagProperty the asset tag property 090 * @return the asset tag property 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.AssetTagProperty deleteAssetTagProperty( 095 com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty) 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.AssetTagPropertyModelImpl}. 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.AssetTagPropertyModelImpl}. 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.AssetTagProperty fetchAssetTagProperty( 177 long tagPropertyId) 178 throws com.liferay.portal.kernel.exception.SystemException; 179 180 /** 181 * Returns the asset tag property with the primary key. 182 * 183 * @param tagPropertyId the primary key of the asset tag property 184 * @return the asset tag property 185 * @throws PortalException if a asset tag property 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.AssetTagProperty getAssetTagProperty( 190 long tagPropertyId) 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 properties. 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.AssetTagPropertyModelImpl}. 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 properties 209 * @param end the upper bound of the range of asset tag properties (not inclusive) 210 * @return the range of asset tag properties 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.AssetTagProperty> getAssetTagProperties( 215 int start, int end) 216 throws com.liferay.portal.kernel.exception.SystemException; 217 218 /** 219 * Returns the number of asset tag properties. 220 * 221 * @return the number of asset tag properties 222 * @throws SystemException if a system exception occurred 223 */ 224 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 225 public int getAssetTagPropertiesCount() 226 throws com.liferay.portal.kernel.exception.SystemException; 227 228 /** 229 * Updates the asset tag property in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 230 * 231 * @param assetTagProperty the asset tag property 232 * @return the asset tag property 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.AssetTagProperty updateAssetTagProperty( 237 com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty) 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 property. 256 * 257 * @param userId the primary key of the user 258 * @param tagId the primary key of the tag 259 * @param key the key to be associated to the value 260 * @param value the value to which the key will refer 261 * @return the created asset tag property 262 * @throws PortalException if a user with the primary key could not be 263 found, or if the key or value were invalid 264 * @throws SystemException if a system exception occurred 265 */ 266 public com.liferay.portlet.asset.model.AssetTagProperty addTagProperty( 267 long userId, long tagId, java.lang.String key, java.lang.String value) 268 throws com.liferay.portal.kernel.exception.PortalException, 269 com.liferay.portal.kernel.exception.SystemException; 270 271 /** 272 * Deletes the asset tag property with the specified tag ID. 273 * 274 * @param tagId the primary key of the tag 275 * @throws SystemException if a system exception occurred 276 */ 277 public void deleteTagProperties(long tagId) 278 throws com.liferay.portal.kernel.exception.SystemException; 279 280 /** 281 * Deletes the asset tag property instance. 282 * 283 * @param tagProperty the asset tag property instance 284 * @throws SystemException if a system exception occurred 285 */ 286 public void deleteTagProperty( 287 com.liferay.portlet.asset.model.AssetTagProperty tagProperty) 288 throws com.liferay.portal.kernel.exception.SystemException; 289 290 /** 291 * Deletes the asset tag property with the specified ID. 292 * 293 * @param tagPropertyId the primary key of the asset tag property instance 294 * @throws PortalException if an asset tag property with the primary key 295 could not be found 296 * @throws SystemException if a system exception occurred 297 */ 298 public void deleteTagProperty(long tagPropertyId) 299 throws com.liferay.portal.kernel.exception.PortalException, 300 com.liferay.portal.kernel.exception.SystemException; 301 302 /** 303 * Returns all the asset tag property instances. 304 * 305 * @return the asset tag property instances 306 * @throws SystemException if a system exception occurred 307 */ 308 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 309 public java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getTagProperties() 310 throws com.liferay.portal.kernel.exception.SystemException; 311 312 /** 313 * Returns all the asset tag property instances with the specified tag ID. 314 * 315 * @param tagId the primary key of the tag 316 * @return the matching asset tag properties 317 * @throws SystemException if a system exception occurred 318 */ 319 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 320 public java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getTagProperties( 321 long tagId) throws com.liferay.portal.kernel.exception.SystemException; 322 323 /** 324 * Returns the asset tag property with the specified ID. 325 * 326 * @param tagPropertyId the primary key of the asset tag property 327 * @return the matching asset tag property 328 * @throws PortalException if an asset tag property with the primary key 329 could not be found 330 * @throws SystemException if a system exception occurred 331 */ 332 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 333 public com.liferay.portlet.asset.model.AssetTagProperty getTagProperty( 334 long tagPropertyId) 335 throws com.liferay.portal.kernel.exception.PortalException, 336 com.liferay.portal.kernel.exception.SystemException; 337 338 /** 339 * Returns the asset tag property with the specified tag ID and key. 340 * 341 * @param tagId the primary key of the tag 342 * @param key the key that refers to some value 343 * @return the matching asset tag property 344 * @throws PortalException if an asset tag property with the tag ID and key 345 could not be found 346 * @throws SystemException if a system exception occurred 347 */ 348 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 349 public com.liferay.portlet.asset.model.AssetTagProperty getTagProperty( 350 long tagId, java.lang.String key) 351 throws com.liferay.portal.kernel.exception.PortalException, 352 com.liferay.portal.kernel.exception.SystemException; 353 354 /** 355 * Returns asset tag property keys with the specified group 356 * 357 * @param groupId the primary key of the group 358 * @return the matching asset tag property keys 359 * @throws SystemException if a system exception occurred 360 */ 361 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 362 public java.lang.String[] getTagPropertyKeys(long groupId) 363 throws com.liferay.portal.kernel.exception.SystemException; 364 365 /** 366 * Returns asset tag properties with the specified group and key. 367 * 368 * @param groupId the primary key of the group 369 * @param key the key that refers to some value 370 * @return the matching asset tag properties 371 * @throws SystemException if a system exception occurred 372 */ 373 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 374 public java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getTagPropertyValues( 375 long groupId, java.lang.String key) 376 throws com.liferay.portal.kernel.exception.SystemException; 377 378 /** 379 * Updates the asset tag property. 380 * 381 * @param tagPropertyId the primary key of the asset tag property 382 * @param key the new key to be associated to the value 383 * @param value the new value to which the key will refer 384 * @return the updated asset tag property 385 * @throws PortalException if an asset tag property with the primary key 386 could not be found, or if the key or value were invalid 387 * @throws SystemException if a system exception occurred 388 */ 389 public com.liferay.portlet.asset.model.AssetTagProperty updateTagProperty( 390 long tagPropertyId, java.lang.String key, java.lang.String value) 391 throws com.liferay.portal.kernel.exception.PortalException, 392 com.liferay.portal.kernel.exception.SystemException; 393 }