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