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