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