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.
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.
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.
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            * Updates the asset link in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
238            *
239            * @param assetLink the asset link
240            * @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.
241            * @return the asset link that was updated
242            * @throws SystemException if a system exception occurred
243            */
244            public static com.liferay.portlet.asset.model.AssetLink updateAssetLink(
245                    com.liferay.portlet.asset.model.AssetLink assetLink, boolean merge)
246                    throws com.liferay.portal.kernel.exception.SystemException {
247                    return getService().updateAssetLink(assetLink, merge);
248            }
249    
250            /**
251            * Returns the Spring bean ID for this bean.
252            *
253            * @return the Spring bean ID for this bean
254            */
255            public static java.lang.String getBeanIdentifier() {
256                    return getService().getBeanIdentifier();
257            }
258    
259            /**
260            * Sets the Spring bean ID for this bean.
261            *
262            * @param beanIdentifier the Spring bean ID for this bean
263            */
264            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
265                    getService().setBeanIdentifier(beanIdentifier);
266            }
267    
268            /**
269            * Adds a new asset link.
270            *
271            * @param userId the primary key of the link's creator
272            * @param entryId1 the primary key of the first asset entry
273            * @param entryId2 the primary key of the second asset entry
274            * @param type the link type. Acceptable values include {@link
275            com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED}
276            which is a bidirectional relationship and {@link
277            com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD}
278            which is a unidirectional relationship. For more information see
279            {@link com.liferay.portlet.asset.model.AssetLinkConstants}
280            * @param weight the weight of the relationship, allowing precedence
281            ordering of links
282            * @return the asset link
283            * @throws PortalException if the user could not be found
284            * @throws SystemException if a system exception occurred
285            */
286            public static com.liferay.portlet.asset.model.AssetLink addLink(
287                    long userId, long entryId1, long entryId2, int type, int weight)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException {
290                    return getService().addLink(userId, entryId1, entryId2, type, weight);
291            }
292    
293            /**
294            * Deletes the asset link.
295            *
296            * @param link the asset link
297            * @throws SystemException if a system exception occurred
298            */
299            public static void deleteLink(
300                    com.liferay.portlet.asset.model.AssetLink link)
301                    throws com.liferay.portal.kernel.exception.SystemException {
302                    getService().deleteLink(link);
303            }
304    
305            /**
306            * Deletes the asset link.
307            *
308            * @param linkId the primary key of the asset link
309            * @throws PortalException if the asset link could not be found
310            * @throws SystemException if a system exception occurred
311            */
312            public static void deleteLink(long linkId)
313                    throws com.liferay.portal.kernel.exception.PortalException,
314                            com.liferay.portal.kernel.exception.SystemException {
315                    getService().deleteLink(linkId);
316            }
317    
318            /**
319            * Deletes all links associated with the asset entry.
320            *
321            * @param entryId the primary key of the asset entry
322            * @throws SystemException if a system exception occurred
323            */
324            public static void deleteLinks(long entryId)
325                    throws com.liferay.portal.kernel.exception.SystemException {
326                    getService().deleteLinks(entryId);
327            }
328    
329            /**
330            * Delete all links that associate the two asset entries.
331            *
332            * @param entryId1 the primary key of the first asset entry
333            * @param entryId2 the primary key of the second asset entry
334            * @throws SystemException if a system exception occurred
335            */
336            public static void deleteLinks(long entryId1, long entryId2)
337                    throws com.liferay.portal.kernel.exception.SystemException {
338                    getService().deleteLinks(entryId1, entryId2);
339            }
340    
341            /**
342            * Returns all the asset links whose first entry ID is the given entry ID.
343            *
344            * @param entryId the primary key of the asset entry
345            * @return the asset links whose first entry ID is the given entry ID
346            * @throws SystemException if a system exception occurred
347            */
348            public static java.util.List<com.liferay.portlet.asset.model.AssetLink> getDirectLinks(
349                    long entryId)
350                    throws com.liferay.portal.kernel.exception.SystemException {
351                    return getService().getDirectLinks(entryId);
352            }
353    
354            /**
355            * Returns all the asset links of the given link type whose first entry ID
356            * is the given entry ID.
357            *
358            * @param entryId the primary key of the asset entry
359            * @param typeId the link type. Acceptable values include {@link
360            com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED}
361            which is a bidirectional relationship and {@link
362            com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD}
363            which is a unidirectional relationship. For more information see
364            {@link com.liferay.portlet.asset.model.AssetLinkConstants}
365            * @return the asset links of the given link type whose first entry ID is
366            the given entry ID
367            * @throws SystemException if a system exception occurred
368            */
369            public static java.util.List<com.liferay.portlet.asset.model.AssetLink> getDirectLinks(
370                    long entryId, int typeId)
371                    throws com.liferay.portal.kernel.exception.SystemException {
372                    return getService().getDirectLinks(entryId, typeId);
373            }
374    
375            /**
376            * Returns all the asset links whose first or second entry ID is the given
377            * entry ID.
378            *
379            * @param entryId the primary key of the asset entry
380            * @return the asset links whose first or second entry ID is the given entry
381            ID
382            * @throws SystemException if a system exception occurred
383            */
384            public static java.util.List<com.liferay.portlet.asset.model.AssetLink> getLinks(
385                    long entryId)
386                    throws com.liferay.portal.kernel.exception.SystemException {
387                    return getService().getLinks(entryId);
388            }
389    
390            /**
391            * Returns all the asset links of the given link type whose first or second
392            * entry ID is the given entry ID.
393            *
394            * @param entryId the primary key of the asset entry
395            * @param typeId the link type. Acceptable values include {@link
396            com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED}
397            which is a bidirectional relationship and {@link
398            com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD}
399            which is a unidirectional relationship. For more information see
400            {@link com.liferay.portlet.asset.model.AssetLinkConstants}
401            * @return the asset links of the given link type whose first or second
402            entry ID is the given entry ID
403            * @throws SystemException if a system exception occurred
404            */
405            public static java.util.List<com.liferay.portlet.asset.model.AssetLink> getLinks(
406                    long entryId, int typeId)
407                    throws com.liferay.portal.kernel.exception.SystemException {
408                    return getService().getLinks(entryId, typeId);
409            }
410    
411            /**
412            * Returns all the asset links of the given link type whose second entry ID
413            * is the given entry ID.
414            *
415            * @param entryId the primary key of the asset entry
416            * @param typeId the link type. Acceptable values include {@link
417            com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED}
418            which is a bidirectional relationship and {@link
419            com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD}
420            which is a unidirectional relationship. For more information see
421            {@link com.liferay.portlet.asset.model.AssetLinkConstants}
422            * @return the asset links of the given link type whose second entry ID is
423            the given entry ID
424            * @throws SystemException if a system exception occurred
425            */
426            public static java.util.List<com.liferay.portlet.asset.model.AssetLink> getReverseLinks(
427                    long entryId, int typeId)
428                    throws com.liferay.portal.kernel.exception.SystemException {
429                    return getService().getReverseLinks(entryId, typeId);
430            }
431    
432            /**
433            * Updates all links of the asset entry, replacing them with links
434            * associating the asset entry with the asset entries of the given link
435            * entry IDs.
436            *
437            * <p>
438            * If no link exists with a given link entry ID, a new link is created
439            * associating the current asset entry with the asset entry of that link
440            * entry ID. An existing link is deleted if either of its entry IDs is not
441            * contained in the given link entry IDs.
442            * </p>
443            *
444            * @param userId the primary key of the user updating the links
445            * @param entryId the primary key of the asset entry to be managed
446            * @param linkEntryIds the primary keys of the asset entries to be linked
447            with the asset entry to be managed
448            * @param typeId the type of the asset links to be created. Acceptable
449            values include {@link
450            com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_RELATED}
451            which is a bidirectional relationship and {@link
452            com.liferay.portlet.asset.model.AssetLinkConstants#TYPE_CHILD}
453            which is a unidirectional relationship. For more information see
454            {@link com.liferay.portlet.asset.model.AssetLinkConstants}
455            * @throws PortalException if the user could not be found
456            * @throws SystemException if a system exception occurred
457            */
458            public static void updateLinks(long userId, long entryId,
459                    long[] linkEntryIds, int typeId)
460                    throws com.liferay.portal.kernel.exception.PortalException,
461                            com.liferay.portal.kernel.exception.SystemException {
462                    getService().updateLinks(userId, entryId, linkEntryIds, typeId);
463            }
464    
465            public static AssetLinkLocalService getService() {
466                    if (_service == null) {
467                            _service = (AssetLinkLocalService)PortalBeanLocatorUtil.locate(AssetLinkLocalService.class.getName());
468    
469                            ReferenceRegistry.registerReference(AssetLinkLocalServiceUtil.class,
470                                    "_service");
471                    }
472    
473                    return _service;
474            }
475    
476            /**
477             * @deprecated
478             */
479            public void setService(AssetLinkLocalService service) {
480            }
481    
482            private static AssetLinkLocalService _service;
483    }