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