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 AssetLink. This utility wraps 022 * {@link com.liferay.portlet.asset.service.impl.AssetLinkLocalServiceImpl} 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 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 * @return the asset link that was removed 070 * @throws PortalException if a asset link 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.AssetLink deleteAssetLink( 074 long linkId) 075 throws com.liferay.portal.kernel.exception.PortalException, 076 com.liferay.portal.kernel.exception.SystemException { 077 return getService().deleteAssetLink(linkId); 078 } 079 080 /** 081 * Deletes the asset link from the database. Also notifies the appropriate model listeners. 082 * 083 * @param assetLink the asset link 084 * @return the asset link that was removed 085 * @throws SystemException if a system exception occurred 086 */ 087 public static com.liferay.portlet.asset.model.AssetLink deleteAssetLink( 088 com.liferay.portlet.asset.model.AssetLink assetLink) 089 throws com.liferay.portal.kernel.exception.SystemException { 090 return getService().deleteAssetLink(assetLink); 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.AssetLinkModelImpl}. 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.AssetLinkModelImpl}. 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.AssetLink fetchAssetLink( 184 long linkId) throws com.liferay.portal.kernel.exception.SystemException { 185 return getService().fetchAssetLink(linkId); 186 } 187 188 /** 189 * Returns the asset link with the primary key. 190 * 191 * @param linkId the primary key of the asset link 192 * @return the asset link 193 * @throws PortalException if a asset link with the primary key could not be found 194 * @throws SystemException if a system exception occurred 195 */ 196 public static com.liferay.portlet.asset.model.AssetLink getAssetLink( 197 long linkId) 198 throws com.liferay.portal.kernel.exception.PortalException, 199 com.liferay.portal.kernel.exception.SystemException { 200 return getService().getAssetLink(linkId); 201 } 202 203 public static com.liferay.portal.model.PersistedModel getPersistedModel( 204 java.io.Serializable primaryKeyObj) 205 throws com.liferay.portal.kernel.exception.PortalException, 206 com.liferay.portal.kernel.exception.SystemException { 207 return getService().getPersistedModel(primaryKeyObj); 208 } 209 210 /** 211 * Returns a range of all the asset links. 212 * 213 * <p> 214 * 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.AssetLinkModelImpl}. 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. 215 * </p> 216 * 217 * @param start the lower bound of the range of asset links 218 * @param end the upper bound of the range of asset links (not inclusive) 219 * @return the range of asset links 220 * @throws SystemException if a system exception occurred 221 */ 222 public static java.util.List<com.liferay.portlet.asset.model.AssetLink> getAssetLinks( 223 int start, int end) 224 throws com.liferay.portal.kernel.exception.SystemException { 225 return getService().getAssetLinks(start, end); 226 } 227 228 /** 229 * Returns the number of asset links. 230 * 231 * @return the number of asset links 232 * @throws SystemException if a system exception occurred 233 */ 234 public static int getAssetLinksCount() 235 throws com.liferay.portal.kernel.exception.SystemException { 236 return getService().getAssetLinksCount(); 237 } 238 239 /** 240 * Updates the asset link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 241 * 242 * @param assetLink the asset link 243 * @return the asset link that was updated 244 * @throws SystemException if a system exception occurred 245 */ 246 public static com.liferay.portlet.asset.model.AssetLink updateAssetLink( 247 com.liferay.portlet.asset.model.AssetLink assetLink) 248 throws com.liferay.portal.kernel.exception.SystemException { 249 return getService().updateAssetLink(assetLink); 250 } 251 252 /** 253 * Returns the Spring bean ID for this bean. 254 * 255 * @return the Spring bean ID for this bean 256 */ 257 public static java.lang.String getBeanIdentifier() { 258 return getService().getBeanIdentifier(); 259 } 260 261 /** 262 * Sets the Spring bean ID for this bean. 263 * 264 * @param beanIdentifier the Spring bean ID for this bean 265 */ 266 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 267 getService().setBeanIdentifier(beanIdentifier); 268 } 269 270 /** 271 * Adds a new asset link. 272 * 273 * @param userId the primary key of the link's creator 274 * @param entryId1 the primary key of the first asset entry 275 * @param entryId2 the primary key of the second asset entry 276 * @param type the link type. Acceptable values include {@link 277 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED} 278 which is a bidirectional relationship and {@link 279 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD} 280 which is a unidirectional relationship. For more information see 281 {@link com.liferay.portlet.asset.model.AssetLinkConstants} 282 * @param weight the weight of the relationship, allowing precedence 283 ordering of links 284 * @return the asset link 285 * @throws PortalException if the user could not be found 286 * @throws SystemException if a system exception occurred 287 */ 288 public static com.liferay.portlet.asset.model.AssetLink addLink( 289 long userId, long entryId1, long entryId2, int type, int weight) 290 throws com.liferay.portal.kernel.exception.PortalException, 291 com.liferay.portal.kernel.exception.SystemException { 292 return getService().addLink(userId, entryId1, entryId2, type, weight); 293 } 294 295 /** 296 * Deletes the asset link. 297 * 298 * @param link the asset link 299 * @throws SystemException if a system exception occurred 300 */ 301 public static void deleteLink( 302 com.liferay.portlet.asset.model.AssetLink link) 303 throws com.liferay.portal.kernel.exception.SystemException { 304 getService().deleteLink(link); 305 } 306 307 /** 308 * Deletes the asset link. 309 * 310 * @param linkId the primary key of the asset link 311 * @throws PortalException if the asset link could not be found 312 * @throws SystemException if a system exception occurred 313 */ 314 public static void deleteLink(long linkId) 315 throws com.liferay.portal.kernel.exception.PortalException, 316 com.liferay.portal.kernel.exception.SystemException { 317 getService().deleteLink(linkId); 318 } 319 320 /** 321 * Deletes all links associated with the asset entry. 322 * 323 * @param entryId the primary key of the asset entry 324 * @throws SystemException if a system exception occurred 325 */ 326 public static void deleteLinks(long entryId) 327 throws com.liferay.portal.kernel.exception.SystemException { 328 getService().deleteLinks(entryId); 329 } 330 331 /** 332 * Delete all links that associate the two asset entries. 333 * 334 * @param entryId1 the primary key of the first asset entry 335 * @param entryId2 the primary key of the second asset entry 336 * @throws SystemException if a system exception occurred 337 */ 338 public static void deleteLinks(long entryId1, long entryId2) 339 throws com.liferay.portal.kernel.exception.SystemException { 340 getService().deleteLinks(entryId1, entryId2); 341 } 342 343 /** 344 * Returns all the asset links whose first entry ID is the given entry ID. 345 * 346 * @param entryId the primary key of the asset entry 347 * @return the asset links whose first entry ID is the given entry ID 348 * @throws SystemException if a system exception occurred 349 */ 350 public static java.util.List<com.liferay.portlet.asset.model.AssetLink> getDirectLinks( 351 long entryId) 352 throws com.liferay.portal.kernel.exception.SystemException { 353 return getService().getDirectLinks(entryId); 354 } 355 356 /** 357 * Returns all the asset links of the given link type whose first entry ID 358 * is the given entry ID. 359 * 360 * @param entryId the primary key of the asset entry 361 * @param typeId the link type. Acceptable values include {@link 362 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED} 363 which is a bidirectional relationship and {@link 364 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD} 365 which is a unidirectional relationship. For more information see 366 {@link com.liferay.portlet.asset.model.AssetLinkConstants} 367 * @return the asset links of the given link type whose first entry ID is 368 the given entry ID 369 * @throws SystemException if a system exception occurred 370 */ 371 public static java.util.List<com.liferay.portlet.asset.model.AssetLink> getDirectLinks( 372 long entryId, int typeId) 373 throws com.liferay.portal.kernel.exception.SystemException { 374 return getService().getDirectLinks(entryId, typeId); 375 } 376 377 /** 378 * Returns all the asset links whose first or second entry ID is the given 379 * entry ID. 380 * 381 * @param entryId the primary key of the asset entry 382 * @return the asset links whose first or second entry ID is the given entry 383 ID 384 * @throws SystemException if a system exception occurred 385 */ 386 public static java.util.List<com.liferay.portlet.asset.model.AssetLink> getLinks( 387 long entryId) 388 throws com.liferay.portal.kernel.exception.SystemException { 389 return getService().getLinks(entryId); 390 } 391 392 /** 393 * Returns all the asset links of the given link type whose first or second 394 * entry ID is the given entry ID. 395 * 396 * @param entryId the primary key of the asset entry 397 * @param typeId the link type. Acceptable values include {@link 398 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED} 399 which is a bidirectional relationship and {@link 400 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD} 401 which is a unidirectional relationship. For more information see 402 {@link com.liferay.portlet.asset.model.AssetLinkConstants} 403 * @return the asset links of the given link type whose first or second 404 entry ID is the given entry ID 405 * @throws SystemException if a system exception occurred 406 */ 407 public static java.util.List<com.liferay.portlet.asset.model.AssetLink> getLinks( 408 long entryId, int typeId) 409 throws com.liferay.portal.kernel.exception.SystemException { 410 return getService().getLinks(entryId, typeId); 411 } 412 413 /** 414 * Returns all the asset links of the given link type whose second entry ID 415 * is the given entry ID. 416 * 417 * @param entryId the primary key of the asset entry 418 * @param typeId the link type. Acceptable values include {@link 419 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED} 420 which is a bidirectional relationship and {@link 421 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD} 422 which is a unidirectional relationship. For more information see 423 {@link com.liferay.portlet.asset.model.AssetLinkConstants} 424 * @return the asset links of the given link type whose second entry ID is 425 the given entry ID 426 * @throws SystemException if a system exception occurred 427 */ 428 public static java.util.List<com.liferay.portlet.asset.model.AssetLink> getReverseLinks( 429 long entryId, int typeId) 430 throws com.liferay.portal.kernel.exception.SystemException { 431 return getService().getReverseLinks(entryId, typeId); 432 } 433 434 public static com.liferay.portlet.asset.model.AssetLink updateLink( 435 long userId, long entryId1, long entryId2, int typeId, int weight) 436 throws com.liferay.portal.kernel.exception.PortalException, 437 com.liferay.portal.kernel.exception.SystemException { 438 return getService() 439 .updateLink(userId, entryId1, entryId2, typeId, weight); 440 } 441 442 /** 443 * Updates all links of the asset entry, replacing them with links 444 * associating the asset entry with the asset entries of the given link 445 * entry IDs. 446 * 447 * <p> 448 * If no link exists with a given link entry ID, a new link is created 449 * associating the current asset entry with the asset entry of that link 450 * entry ID. An existing link is deleted if either of its entry IDs is not 451 * contained in the given link entry IDs. 452 * </p> 453 * 454 * @param userId the primary key of the user updating the links 455 * @param entryId the primary key of the asset entry to be managed 456 * @param linkEntryIds the primary keys of the asset entries to be linked 457 with the asset entry to be managed 458 * @param typeId the type of the asset links to be created. Acceptable 459 values include {@link 460 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED} 461 which is a bidirectional relationship and {@link 462 com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD} 463 which is a unidirectional relationship. For more information see 464 {@link com.liferay.portlet.asset.model.AssetLinkConstants} 465 * @throws PortalException if the user could not be found 466 * @throws SystemException if a system exception occurred 467 */ 468 public static void updateLinks(long userId, long entryId, 469 long[] linkEntryIds, int typeId) 470 throws com.liferay.portal.kernel.exception.PortalException, 471 com.liferay.portal.kernel.exception.SystemException { 472 getService().updateLinks(userId, entryId, linkEntryIds, typeId); 473 } 474 475 public static AssetLinkLocalService getService() { 476 if (_service == null) { 477 _service = (AssetLinkLocalService)PortalBeanLocatorUtil.locate(AssetLinkLocalService.class.getName()); 478 479 ReferenceRegistry.registerReference(AssetLinkLocalServiceUtil.class, 480 "_service"); 481 } 482 483 return _service; 484 } 485 486 /** 487 * @deprecated As of 6.2.0 488 */ 489 public void setService(AssetLinkLocalService service) { 490 } 491 492 private static AssetLinkLocalService _service; 493 }