001 /** 002 * Copyright (c) 2000-2011 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.MethodCache; 019 import com.liferay.portal.kernel.util.ReferenceRegistry; 020 021 /** 022 * The utility for the asset link local service. This utility wraps {@link com.liferay.portlet.asset.service.impl.AssetLinkLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server. 023 * 024 * <p> 025 * 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. 026 * </p> 027 * 028 * @author Brian Wing Shun Chan 029 * @see AssetLinkLocalService 030 * @see com.liferay.portlet.asset.service.base.AssetLinkLocalServiceBaseImpl 031 * @see com.liferay.portlet.asset.service.impl.AssetLinkLocalServiceImpl 032 * @generated 033 */ 034 public class AssetLinkLocalServiceUtil { 035 /* 036 * NOTE FOR DEVELOPERS: 037 * 038 * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.asset.service.impl.AssetLinkLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 039 */ 040 041 /** 042 * Adds the asset link to the database. Also notifies the appropriate model listeners. 043 * 044 * @param assetLink the asset link 045 * @return the asset link that was added 046 * @throws SystemException if a system exception occurred 047 */ 048 public static com.liferay.portlet.asset.model.AssetLink addAssetLink( 049 com.liferay.portlet.asset.model.AssetLink assetLink) 050 throws com.liferay.portal.kernel.exception.SystemException { 051 return getService().addAssetLink(assetLink); 052 } 053 054 /** 055 * Creates a new asset link with the primary key. Does not add the asset link to the database. 056 * 057 * @param linkId the primary key for the new asset link 058 * @return the new asset link 059 */ 060 public static com.liferay.portlet.asset.model.AssetLink createAssetLink( 061 long linkId) { 062 return getService().createAssetLink(linkId); 063 } 064 065 /** 066 * Deletes the asset link with the primary key from the database. Also notifies the appropriate model listeners. 067 * 068 * @param linkId the primary key of the asset link 069 * @throws PortalException if a asset link with the primary key could not be found 070 * @throws SystemException if a system exception occurred 071 */ 072 public static void deleteAssetLink(long linkId) 073 throws com.liferay.portal.kernel.exception.PortalException, 074 com.liferay.portal.kernel.exception.SystemException { 075 getService().deleteAssetLink(linkId); 076 } 077 078 /** 079 * Deletes the asset link from the database. Also notifies the appropriate model listeners. 080 * 081 * @param assetLink the asset link 082 * @throws SystemException if a system exception occurred 083 */ 084 public static void deleteAssetLink( 085 com.liferay.portlet.asset.model.AssetLink assetLink) 086 throws com.liferay.portal.kernel.exception.SystemException { 087 getService().deleteAssetLink(assetLink); 088 } 089 090 /** 091 * Performs a dynamic query on the database and returns the matching rows. 092 * 093 * @param dynamicQuery the dynamic query 094 * @return the matching rows 095 * @throws SystemException if a system exception occurred 096 */ 097 @SuppressWarnings("rawtypes") 098 public static java.util.List dynamicQuery( 099 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 100 throws com.liferay.portal.kernel.exception.SystemException { 101 return getService().dynamicQuery(dynamicQuery); 102 } 103 104 /** 105 * Performs a dynamic query on the database and returns a range of the matching rows. 106 * 107 * <p> 108 * 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. 109 * </p> 110 * 111 * @param dynamicQuery the dynamic query 112 * @param start the lower bound of the range of model instances 113 * @param end the upper bound of the range of model instances (not inclusive) 114 * @return the range of matching rows 115 * @throws SystemException if a system exception occurred 116 */ 117 @SuppressWarnings("rawtypes") 118 public static java.util.List dynamicQuery( 119 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 120 int end) throws com.liferay.portal.kernel.exception.SystemException { 121 return getService().dynamicQuery(dynamicQuery, start, end); 122 } 123 124 /** 125 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 126 * 127 * <p> 128 * 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. 129 * </p> 130 * 131 * @param dynamicQuery the dynamic query 132 * @param start the lower bound of the range of model instances 133 * @param end the upper bound of the range of model instances (not inclusive) 134 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 135 * @return the ordered range of matching rows 136 * @throws SystemException if a system exception occurred 137 */ 138 @SuppressWarnings("rawtypes") 139 public static java.util.List dynamicQuery( 140 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 141 int end, 142 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 143 throws com.liferay.portal.kernel.exception.SystemException { 144 return getService() 145 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 146 } 147 148 /** 149 * Returns the number of rows that match the dynamic query. 150 * 151 * @param dynamicQuery the dynamic query 152 * @return the number of rows that match the dynamic query 153 * @throws SystemException if a system exception occurred 154 */ 155 public static long dynamicQueryCount( 156 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 157 throws com.liferay.portal.kernel.exception.SystemException { 158 return getService().dynamicQueryCount(dynamicQuery); 159 } 160 161 /** 162 * Returns the asset link with the primary key. 163 * 164 * @param linkId the primary key of the asset link 165 * @return the asset link 166 * @throws PortalException if a asset link with the primary key could not be found 167 * @throws SystemException if a system exception occurred 168 */ 169 public static com.liferay.portlet.asset.model.AssetLink getAssetLink( 170 long linkId) 171 throws com.liferay.portal.kernel.exception.PortalException, 172 com.liferay.portal.kernel.exception.SystemException { 173 return getService().getAssetLink(linkId); 174 } 175 176 public static com.liferay.portal.model.PersistedModel getPersistedModel( 177 java.io.Serializable primaryKeyObj) 178 throws com.liferay.portal.kernel.exception.PortalException, 179 com.liferay.portal.kernel.exception.SystemException { 180 return getService().getPersistedModel(primaryKeyObj); 181 } 182 183 /** 184 * Returns a range of all the asset links. 185 * 186 * <p> 187 * 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. 188 * </p> 189 * 190 * @param start the lower bound of the range of asset links 191 * @param end the upper bound of the range of asset links (not inclusive) 192 * @return the range of asset links 193 * @throws SystemException if a system exception occurred 194 */ 195 public static java.util.List<com.liferay.portlet.asset.model.AssetLink> getAssetLinks( 196 int start, int end) 197 throws com.liferay.portal.kernel.exception.SystemException { 198 return getService().getAssetLinks(start, end); 199 } 200 201 /** 202 * Returns the number of asset links. 203 * 204 * @return the number of asset links 205 * @throws SystemException if a system exception occurred 206 */ 207 public static int getAssetLinksCount() 208 throws com.liferay.portal.kernel.exception.SystemException { 209 return getService().getAssetLinksCount(); 210 } 211 212 /** 213 * Updates the asset link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 214 * 215 * @param assetLink the asset link 216 * @return the asset link that was updated 217 * @throws SystemException if a system exception occurred 218 */ 219 public static com.liferay.portlet.asset.model.AssetLink updateAssetLink( 220 com.liferay.portlet.asset.model.AssetLink assetLink) 221 throws com.liferay.portal.kernel.exception.SystemException { 222 return getService().updateAssetLink(assetLink); 223 } 224 225 /** 226 * Updates the asset link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 227 * 228 * @param assetLink the asset link 229 * @param merge whether to merge the asset link with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation. 230 * @return the asset link that was updated 231 * @throws SystemException if a system exception occurred 232 */ 233 public static com.liferay.portlet.asset.model.AssetLink updateAssetLink( 234 com.liferay.portlet.asset.model.AssetLink assetLink, boolean merge) 235 throws com.liferay.portal.kernel.exception.SystemException { 236 return getService().updateAssetLink(assetLink, merge); 237 } 238 239 /** 240 * Returns the Spring bean ID for this bean. 241 * 242 * @return the Spring bean ID for this bean 243 */ 244 public static java.lang.String getBeanIdentifier() { 245 return getService().getBeanIdentifier(); 246 } 247 248 /** 249 * Sets the Spring bean ID for this bean. 250 * 251 * @param beanIdentifier the Spring bean ID for this bean 252 */ 253 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 254 getService().setBeanIdentifier(beanIdentifier); 255 } 256 257 /** 258 * Adds a new asset link. 259 * 260 * @param userId the primary key of the link's creator 261 * @param entryId1 the primary key of the first asset entry 262 * @param entryId2 the primary key of the second asset entry 263 * @param type the link type. Acceptable values include {@link 264 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED} 265 which is a bidirectional relationship and {@link 266 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD} 267 which is a unidirectional relationship. For more information see 268 {@link com.liferay.portlet.asset.model.AssetLinkConstants} 269 * @param weight the weight of the relationship, allowing precedence 270 ordering of links 271 * @return the asset link 272 * @throws PortalException if the user could not be found 273 * @throws SystemException if a system exception occurred 274 */ 275 public static com.liferay.portlet.asset.model.AssetLink addLink( 276 long userId, long entryId1, long entryId2, int type, int weight) 277 throws com.liferay.portal.kernel.exception.PortalException, 278 com.liferay.portal.kernel.exception.SystemException { 279 return getService().addLink(userId, entryId1, entryId2, type, weight); 280 } 281 282 /** 283 * Deletes the asset link. 284 * 285 * @param link the asset link 286 * @throws SystemException if a system exception occurred 287 */ 288 public static void deleteLink( 289 com.liferay.portlet.asset.model.AssetLink link) 290 throws com.liferay.portal.kernel.exception.SystemException { 291 getService().deleteLink(link); 292 } 293 294 /** 295 * Deletes the asset link. 296 * 297 * @param linkId the primary key of the asset link 298 * @throws PortalException if the asset link could not be found 299 * @throws SystemException if a system exception occurred 300 */ 301 public static void deleteLink(long linkId) 302 throws com.liferay.portal.kernel.exception.PortalException, 303 com.liferay.portal.kernel.exception.SystemException { 304 getService().deleteLink(linkId); 305 } 306 307 /** 308 * Deletes all links associated with the asset entry. 309 * 310 * @param entryId the primary key of the asset entry 311 * @throws SystemException if a system exception occurred 312 */ 313 public static void deleteLinks(long entryId) 314 throws com.liferay.portal.kernel.exception.SystemException { 315 getService().deleteLinks(entryId); 316 } 317 318 /** 319 * Delete all links that associate the two asset entries. 320 * 321 * @param entryId1 the primary key of the first asset entry 322 * @param entryId2 the primary key of the second asset entry 323 * @throws SystemException if a system exception occurred 324 */ 325 public static void deleteLinks(long entryId1, long entryId2) 326 throws com.liferay.portal.kernel.exception.SystemException { 327 getService().deleteLinks(entryId1, entryId2); 328 } 329 330 /** 331 * Returns all the asset links whose first entry ID is the given entry ID. 332 * 333 * @param entryId the primary key of the asset entry 334 * @return the asset links whose first entry ID is the given entry ID 335 * @throws SystemException if a system exception occurred 336 */ 337 public static java.util.List<com.liferay.portlet.asset.model.AssetLink> getDirectLinks( 338 long entryId) 339 throws com.liferay.portal.kernel.exception.SystemException { 340 return getService().getDirectLinks(entryId); 341 } 342 343 /** 344 * Returns all the asset links of the given link type whose first entry ID 345 * is the given entry ID. 346 * 347 * @param entryId the primary key of the asset entry 348 * @param typeId the link type. Acceptable values include {@link 349 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED} 350 which is a bidirectional relationship and {@link 351 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD} 352 which is a unidirectional relationship. For more information see 353 {@link com.liferay.portlet.asset.model.AssetLinkConstants} 354 * @return the asset links of the given link type whose first entry ID is 355 the given entry ID 356 * @throws SystemException if a system exception occurred 357 */ 358 public static java.util.List<com.liferay.portlet.asset.model.AssetLink> getDirectLinks( 359 long entryId, int typeId) 360 throws com.liferay.portal.kernel.exception.SystemException { 361 return getService().getDirectLinks(entryId, typeId); 362 } 363 364 /** 365 * Returns all the asset links whose first or second entry ID is the given 366 * entry ID. 367 * 368 * @param entryId the primary key of the asset entry 369 * @return the asset links whose first or second entry ID is the given 370 entry ID 371 * @throws SystemException if a system exception occurred 372 */ 373 public static java.util.List<com.liferay.portlet.asset.model.AssetLink> getLinks( 374 long entryId) 375 throws com.liferay.portal.kernel.exception.SystemException { 376 return getService().getLinks(entryId); 377 } 378 379 /** 380 * Returns all the asset links of the given link type whose first or second 381 * entry ID is the given entry ID. 382 * 383 * @param entryId the primary key of the asset entry 384 * @param typeId the link type. Acceptable values include {@link 385 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED} 386 which is a bidirectional relationship and {@link 387 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD} 388 which is a unidirectional relationship. For more information see 389 {@link com.liferay.portlet.asset.model.AssetLinkConstants} 390 * @return the asset links of the given link type whose first or second 391 entry ID is the given entry ID 392 * @throws SystemException if a system exception occurred 393 */ 394 public static java.util.List<com.liferay.portlet.asset.model.AssetLink> getLinks( 395 long entryId, int typeId) 396 throws com.liferay.portal.kernel.exception.SystemException { 397 return getService().getLinks(entryId, typeId); 398 } 399 400 /** 401 * Returns all the asset links of the given link type whose second entry ID 402 * is the given entry ID. 403 * 404 * @param entryId the primary key of the asset entry 405 * @param typeId the link type. Acceptable values include {@link 406 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED} 407 which is a bidirectional relationship and {@link 408 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD} 409 which is a unidirectional relationship. For more information see 410 {@link com.liferay.portlet.asset.model.AssetLinkConstants} 411 * @return the asset links of the given link type whose second entry ID is 412 the given entry ID 413 * @throws SystemException if a system exception occurred 414 */ 415 public static java.util.List<com.liferay.portlet.asset.model.AssetLink> getReverseLinks( 416 long entryId, int typeId) 417 throws com.liferay.portal.kernel.exception.SystemException { 418 return getService().getReverseLinks(entryId, typeId); 419 } 420 421 /** 422 * Updates all links of the asset entry, replacing them with links 423 * associating the asset entry with the asset entries of the given link 424 * entry IDs. 425 * 426 * <p> 427 * If no link exists with a given link entry ID, a new link is created 428 * associating the current asset entry with the asset entry of that link 429 * entry ID. An existing link is deleted if either of its entry IDs is not 430 * contained in the given link entry IDs. 431 * </p> 432 * 433 * @param userId the primary key of the user updating the links 434 * @param entryId the primary key of the asset entry to be managed 435 * @param linkEntryIds the primary keys of the asset entries to be linked 436 with the asset entry to be managed 437 * @param typeId the type of the asset links to be created. Acceptable 438 values include {@link 439 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED} 440 which is a bidirectional relationship and {@link 441 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD} 442 which is a unidirectional relationship. For more information see 443 {@link com.liferay.portlet.asset.model.AssetLinkConstants} 444 * @throws PortalException if the user could not be found 445 * @throws SystemException if a system exception occurred 446 */ 447 public static void updateLinks(long userId, long entryId, 448 long[] linkEntryIds, int typeId) 449 throws com.liferay.portal.kernel.exception.PortalException, 450 com.liferay.portal.kernel.exception.SystemException { 451 getService().updateLinks(userId, entryId, linkEntryIds, typeId); 452 } 453 454 public static AssetLinkLocalService getService() { 455 if (_service == null) { 456 _service = (AssetLinkLocalService)PortalBeanLocatorUtil.locate(AssetLinkLocalService.class.getName()); 457 458 ReferenceRegistry.registerReference(AssetLinkLocalServiceUtil.class, 459 "_service"); 460 MethodCache.remove(AssetLinkLocalService.class); 461 } 462 463 return _service; 464 } 465 466 public void setService(AssetLinkLocalService service) { 467 MethodCache.remove(AssetLinkLocalService.class); 468 469 _service = service; 470 471 ReferenceRegistry.registerReference(AssetLinkLocalServiceUtil.class, 472 "_service"); 473 MethodCache.remove(AssetLinkLocalService.class); 474 } 475 476 private static AssetLinkLocalService _service; 477 }