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.bean.PortalBeanLocatorUtil; 020 import com.liferay.portal.kernel.util.ReferenceRegistry; 021 022 /** 023 * Provides the local service utility for AssetTagProperty. This utility wraps 024 * {@link com.liferay.portlet.asset.service.impl.AssetTagPropertyLocalServiceImpl} and is the 025 * primary access point for service operations in application layer code running 026 * on the local server. Methods of this service will not have security checks 027 * based on the propagated JAAS credentials because this service can only be 028 * accessed from within the same VM. 029 * 030 * @author Brian Wing Shun Chan 031 * @see AssetTagPropertyLocalService 032 * @see com.liferay.portlet.asset.service.base.AssetTagPropertyLocalServiceBaseImpl 033 * @see com.liferay.portlet.asset.service.impl.AssetTagPropertyLocalServiceImpl 034 * @generated 035 */ 036 @ProviderType 037 public class AssetTagPropertyLocalServiceUtil { 038 /* 039 * NOTE FOR DEVELOPERS: 040 * 041 * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.asset.service.impl.AssetTagPropertyLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 042 */ 043 044 /** 045 * Adds the asset tag property to the database. Also notifies the appropriate model listeners. 046 * 047 * @param assetTagProperty the asset tag property 048 * @return the asset tag property that was added 049 * @throws SystemException if a system exception occurred 050 */ 051 public static com.liferay.portlet.asset.model.AssetTagProperty addAssetTagProperty( 052 com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty) 053 throws com.liferay.portal.kernel.exception.SystemException { 054 return getService().addAssetTagProperty(assetTagProperty); 055 } 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 static com.liferay.portlet.asset.model.AssetTagProperty createAssetTagProperty( 064 long tagPropertyId) { 065 return getService().createAssetTagProperty(tagPropertyId); 066 } 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 static 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 return getService().deleteAssetTagProperty(tagPropertyId); 081 } 082 083 /** 084 * Deletes the asset tag property from the database. Also notifies the appropriate model listeners. 085 * 086 * @param assetTagProperty the asset tag property 087 * @return the asset tag property that was removed 088 * @throws SystemException if a system exception occurred 089 */ 090 public static com.liferay.portlet.asset.model.AssetTagProperty deleteAssetTagProperty( 091 com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty) 092 throws com.liferay.portal.kernel.exception.SystemException { 093 return getService().deleteAssetTagProperty(assetTagProperty); 094 } 095 096 public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 097 return getService().dynamicQuery(); 098 } 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 static java.util.List dynamicQuery( 109 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 110 throws com.liferay.portal.kernel.exception.SystemException { 111 return getService().dynamicQuery(dynamicQuery); 112 } 113 114 /** 115 * Performs a dynamic query on the database and returns a range of the matching rows. 116 * 117 * <p> 118 * 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. 119 * </p> 120 * 121 * @param dynamicQuery the dynamic query 122 * @param start the lower bound of the range of model instances 123 * @param end the upper bound of the range of model instances (not inclusive) 124 * @return the range of matching rows 125 * @throws SystemException if a system exception occurred 126 */ 127 @SuppressWarnings("rawtypes") 128 public static java.util.List dynamicQuery( 129 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 130 int end) throws com.liferay.portal.kernel.exception.SystemException { 131 return getService().dynamicQuery(dynamicQuery, start, end); 132 } 133 134 /** 135 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 136 * 137 * <p> 138 * 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. 139 * </p> 140 * 141 * @param dynamicQuery the dynamic query 142 * @param start the lower bound of the range of model instances 143 * @param end the upper bound of the range of model instances (not inclusive) 144 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 145 * @return the ordered range of matching rows 146 * @throws SystemException if a system exception occurred 147 */ 148 @SuppressWarnings("rawtypes") 149 public static java.util.List dynamicQuery( 150 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 151 int end, 152 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 153 throws com.liferay.portal.kernel.exception.SystemException { 154 return getService() 155 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 156 } 157 158 /** 159 * Returns the number of rows that match the dynamic query. 160 * 161 * @param dynamicQuery the dynamic query 162 * @return the number of rows that match the dynamic query 163 * @throws SystemException if a system exception occurred 164 */ 165 public static long dynamicQueryCount( 166 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 167 throws com.liferay.portal.kernel.exception.SystemException { 168 return getService().dynamicQueryCount(dynamicQuery); 169 } 170 171 /** 172 * Returns the number of rows that match the dynamic query. 173 * 174 * @param dynamicQuery the dynamic query 175 * @param projection the projection to apply to the query 176 * @return the number of rows that match the dynamic query 177 * @throws SystemException if a system exception occurred 178 */ 179 public static long dynamicQueryCount( 180 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 181 com.liferay.portal.kernel.dao.orm.Projection projection) 182 throws com.liferay.portal.kernel.exception.SystemException { 183 return getService().dynamicQueryCount(dynamicQuery, projection); 184 } 185 186 public static com.liferay.portlet.asset.model.AssetTagProperty fetchAssetTagProperty( 187 long tagPropertyId) 188 throws com.liferay.portal.kernel.exception.SystemException { 189 return getService().fetchAssetTagProperty(tagPropertyId); 190 } 191 192 /** 193 * Returns the asset tag property with the primary key. 194 * 195 * @param tagPropertyId the primary key of the asset tag property 196 * @return the asset tag property 197 * @throws PortalException if a asset tag property with the primary key could not be found 198 * @throws SystemException if a system exception occurred 199 */ 200 public static com.liferay.portlet.asset.model.AssetTagProperty getAssetTagProperty( 201 long tagPropertyId) 202 throws com.liferay.portal.kernel.exception.PortalException, 203 com.liferay.portal.kernel.exception.SystemException { 204 return getService().getAssetTagProperty(tagPropertyId); 205 } 206 207 public static com.liferay.portal.model.PersistedModel getPersistedModel( 208 java.io.Serializable primaryKeyObj) 209 throws com.liferay.portal.kernel.exception.PortalException, 210 com.liferay.portal.kernel.exception.SystemException { 211 return getService().getPersistedModel(primaryKeyObj); 212 } 213 214 /** 215 * Returns a range of all the asset tag properties. 216 * 217 * <p> 218 * 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. 219 * </p> 220 * 221 * @param start the lower bound of the range of asset tag properties 222 * @param end the upper bound of the range of asset tag properties (not inclusive) 223 * @return the range of asset tag properties 224 * @throws SystemException if a system exception occurred 225 */ 226 public static java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getAssetTagProperties( 227 int start, int end) 228 throws com.liferay.portal.kernel.exception.SystemException { 229 return getService().getAssetTagProperties(start, end); 230 } 231 232 /** 233 * Returns the number of asset tag properties. 234 * 235 * @return the number of asset tag properties 236 * @throws SystemException if a system exception occurred 237 */ 238 public static int getAssetTagPropertiesCount() 239 throws com.liferay.portal.kernel.exception.SystemException { 240 return getService().getAssetTagPropertiesCount(); 241 } 242 243 /** 244 * Updates the asset tag property in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 245 * 246 * @param assetTagProperty the asset tag property 247 * @return the asset tag property that was updated 248 * @throws SystemException if a system exception occurred 249 */ 250 public static com.liferay.portlet.asset.model.AssetTagProperty updateAssetTagProperty( 251 com.liferay.portlet.asset.model.AssetTagProperty assetTagProperty) 252 throws com.liferay.portal.kernel.exception.SystemException { 253 return getService().updateAssetTagProperty(assetTagProperty); 254 } 255 256 /** 257 * Returns the Spring bean ID for this bean. 258 * 259 * @return the Spring bean ID for this bean 260 */ 261 public static java.lang.String getBeanIdentifier() { 262 return getService().getBeanIdentifier(); 263 } 264 265 /** 266 * Sets the Spring bean ID for this bean. 267 * 268 * @param beanIdentifier the Spring bean ID for this bean 269 */ 270 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 271 getService().setBeanIdentifier(beanIdentifier); 272 } 273 274 /** 275 * Adds an asset tag property. 276 * 277 * @param userId the primary key of the user 278 * @param tagId the primary key of the tag 279 * @param key the key to be associated to the value 280 * @param value the value to which the key will refer 281 * @return the created asset tag property 282 * @throws PortalException if a user with the primary key could not be 283 found, or if the key or value were invalid 284 * @throws SystemException if a system exception occurred 285 */ 286 public static com.liferay.portlet.asset.model.AssetTagProperty addTagProperty( 287 long userId, long tagId, java.lang.String key, java.lang.String value) 288 throws com.liferay.portal.kernel.exception.PortalException, 289 com.liferay.portal.kernel.exception.SystemException { 290 return getService().addTagProperty(userId, tagId, key, value); 291 } 292 293 /** 294 * Deletes the asset tag property with the specified tag ID. 295 * 296 * @param tagId the primary key of the tag 297 * @throws SystemException if a system exception occurred 298 */ 299 public static void deleteTagProperties(long tagId) 300 throws com.liferay.portal.kernel.exception.SystemException { 301 getService().deleteTagProperties(tagId); 302 } 303 304 /** 305 * Deletes the asset tag property instance. 306 * 307 * @param tagProperty the asset tag property instance 308 * @throws SystemException if a system exception occurred 309 */ 310 public static void deleteTagProperty( 311 com.liferay.portlet.asset.model.AssetTagProperty tagProperty) 312 throws com.liferay.portal.kernel.exception.SystemException { 313 getService().deleteTagProperty(tagProperty); 314 } 315 316 /** 317 * Deletes the asset tag property with the specified ID. 318 * 319 * @param tagPropertyId the primary key of the asset tag property instance 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 public static void deleteTagProperty(long tagPropertyId) 325 throws com.liferay.portal.kernel.exception.PortalException, 326 com.liferay.portal.kernel.exception.SystemException { 327 getService().deleteTagProperty(tagPropertyId); 328 } 329 330 /** 331 * Returns all the asset tag property instances. 332 * 333 * @return the asset tag property instances 334 * @throws SystemException if a system exception occurred 335 */ 336 public static java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getTagProperties() 337 throws com.liferay.portal.kernel.exception.SystemException { 338 return getService().getTagProperties(); 339 } 340 341 /** 342 * Returns all the asset tag property instances with the specified tag ID. 343 * 344 * @param tagId the primary key of the tag 345 * @return the matching asset tag properties 346 * @throws SystemException if a system exception occurred 347 */ 348 public static java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getTagProperties( 349 long tagId) throws com.liferay.portal.kernel.exception.SystemException { 350 return getService().getTagProperties(tagId); 351 } 352 353 /** 354 * Returns the asset tag property with the specified ID. 355 * 356 * @param tagPropertyId the primary key of the asset tag property 357 * @return the matching asset tag property 358 * @throws PortalException if an asset tag property with the primary key 359 could not be found 360 * @throws SystemException if a system exception occurred 361 */ 362 public static com.liferay.portlet.asset.model.AssetTagProperty getTagProperty( 363 long tagPropertyId) 364 throws com.liferay.portal.kernel.exception.PortalException, 365 com.liferay.portal.kernel.exception.SystemException { 366 return getService().getTagProperty(tagPropertyId); 367 } 368 369 /** 370 * Returns the asset tag property with the specified tag ID and key. 371 * 372 * @param tagId the primary key of the tag 373 * @param key the key that refers to some value 374 * @return the matching asset tag property 375 * @throws PortalException if an asset tag property with the tag ID and key 376 could not be found 377 * @throws SystemException if a system exception occurred 378 */ 379 public static com.liferay.portlet.asset.model.AssetTagProperty getTagProperty( 380 long tagId, java.lang.String key) 381 throws com.liferay.portal.kernel.exception.PortalException, 382 com.liferay.portal.kernel.exception.SystemException { 383 return getService().getTagProperty(tagId, key); 384 } 385 386 /** 387 * Returns asset tag property keys with the specified group 388 * 389 * @param groupId the primary key of the group 390 * @return the matching asset tag property keys 391 * @throws SystemException if a system exception occurred 392 */ 393 public static java.lang.String[] getTagPropertyKeys(long groupId) 394 throws com.liferay.portal.kernel.exception.SystemException { 395 return getService().getTagPropertyKeys(groupId); 396 } 397 398 /** 399 * Returns asset tag properties with the specified group and key. 400 * 401 * @param groupId the primary key of the group 402 * @param key the key that refers to some value 403 * @return the matching asset tag properties 404 * @throws SystemException if a system exception occurred 405 */ 406 public static java.util.List<com.liferay.portlet.asset.model.AssetTagProperty> getTagPropertyValues( 407 long groupId, java.lang.String key) 408 throws com.liferay.portal.kernel.exception.SystemException { 409 return getService().getTagPropertyValues(groupId, key); 410 } 411 412 /** 413 * Updates the asset tag property. 414 * 415 * @param tagPropertyId the primary key of the asset tag property 416 * @param key the new key to be associated to the value 417 * @param value the new value to which the key will refer 418 * @return the updated asset tag property 419 * @throws PortalException if an asset tag property with the primary key 420 could not be found, or if the key or value were invalid 421 * @throws SystemException if a system exception occurred 422 */ 423 public static com.liferay.portlet.asset.model.AssetTagProperty updateTagProperty( 424 long tagPropertyId, java.lang.String key, java.lang.String value) 425 throws com.liferay.portal.kernel.exception.PortalException, 426 com.liferay.portal.kernel.exception.SystemException { 427 return getService().updateTagProperty(tagPropertyId, key, value); 428 } 429 430 public static AssetTagPropertyLocalService getService() { 431 if (_service == null) { 432 _service = (AssetTagPropertyLocalService)PortalBeanLocatorUtil.locate(AssetTagPropertyLocalService.class.getName()); 433 434 ReferenceRegistry.registerReference(AssetTagPropertyLocalServiceUtil.class, 435 "_service"); 436 } 437 438 return _service; 439 } 440 441 /** 442 * @deprecated As of 6.2.0 443 */ 444 public void setService(AssetTagPropertyLocalService service) { 445 } 446 447 private static AssetTagPropertyLocalService _service; 448 }