001    /**
002     * Copyright (c) 2000-2012 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.bookmarks.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 bookmarks entry local service. This utility wraps {@link com.liferay.portlet.bookmarks.service.impl.BookmarksEntryLocalServiceImpl} 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 BookmarksEntryLocalService
029     * @see com.liferay.portlet.bookmarks.service.base.BookmarksEntryLocalServiceBaseImpl
030     * @see com.liferay.portlet.bookmarks.service.impl.BookmarksEntryLocalServiceImpl
031     * @generated
032     */
033    public class BookmarksEntryLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.bookmarks.service.impl.BookmarksEntryLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the bookmarks entry to the database. Also notifies the appropriate model listeners.
042            *
043            * @param bookmarksEntry the bookmarks entry
044            * @return the bookmarks entry that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.bookmarks.model.BookmarksEntry addBookmarksEntry(
048                    com.liferay.portlet.bookmarks.model.BookmarksEntry bookmarksEntry)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addBookmarksEntry(bookmarksEntry);
051            }
052    
053            /**
054            * Creates a new bookmarks entry with the primary key. Does not add the bookmarks entry to the database.
055            *
056            * @param entryId the primary key for the new bookmarks entry
057            * @return the new bookmarks entry
058            */
059            public static com.liferay.portlet.bookmarks.model.BookmarksEntry createBookmarksEntry(
060                    long entryId) {
061                    return getService().createBookmarksEntry(entryId);
062            }
063    
064            /**
065            * Deletes the bookmarks entry with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param entryId the primary key of the bookmarks entry
068            * @return the bookmarks entry that was removed
069            * @throws PortalException if a bookmarks entry with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portlet.bookmarks.model.BookmarksEntry deleteBookmarksEntry(
073                    long entryId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteBookmarksEntry(entryId);
077            }
078    
079            /**
080            * Deletes the bookmarks entry from the database. Also notifies the appropriate model listeners.
081            *
082            * @param bookmarksEntry the bookmarks entry
083            * @return the bookmarks entry that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.bookmarks.model.BookmarksEntry deleteBookmarksEntry(
087                    com.liferay.portlet.bookmarks.model.BookmarksEntry bookmarksEntry)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteBookmarksEntry(bookmarksEntry);
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.bookmarks.model.impl.BookmarksEntryModelImpl}. 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.bookmarks.model.impl.BookmarksEntryModelImpl}. 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.bookmarks.model.BookmarksEntry fetchBookmarksEntry(
168                    long entryId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchBookmarksEntry(entryId);
171            }
172    
173            /**
174            * Returns the bookmarks entry with the primary key.
175            *
176            * @param entryId the primary key of the bookmarks entry
177            * @return the bookmarks entry
178            * @throws PortalException if a bookmarks entry with the primary key could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.bookmarks.model.BookmarksEntry getBookmarksEntry(
182                    long entryId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getBookmarksEntry(entryId);
186            }
187    
188            public static com.liferay.portal.model.PersistedModel getPersistedModel(
189                    java.io.Serializable primaryKeyObj)
190                    throws com.liferay.portal.kernel.exception.PortalException,
191                            com.liferay.portal.kernel.exception.SystemException {
192                    return getService().getPersistedModel(primaryKeyObj);
193            }
194    
195            /**
196            * Returns the bookmarks entry with the UUID in the group.
197            *
198            * @param uuid the UUID of bookmarks entry
199            * @param groupId the group id of the bookmarks entry
200            * @return the bookmarks entry
201            * @throws PortalException if a bookmarks entry with the UUID in the group could not be found
202            * @throws SystemException if a system exception occurred
203            */
204            public static com.liferay.portlet.bookmarks.model.BookmarksEntry getBookmarksEntryByUuidAndGroupId(
205                    java.lang.String uuid, long groupId)
206                    throws com.liferay.portal.kernel.exception.PortalException,
207                            com.liferay.portal.kernel.exception.SystemException {
208                    return getService().getBookmarksEntryByUuidAndGroupId(uuid, groupId);
209            }
210    
211            /**
212            * Returns a range of all the bookmarks entries.
213            *
214            * <p>
215            * 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.bookmarks.model.impl.BookmarksEntryModelImpl}. 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.
216            * </p>
217            *
218            * @param start the lower bound of the range of bookmarks entries
219            * @param end the upper bound of the range of bookmarks entries (not inclusive)
220            * @return the range of bookmarks entries
221            * @throws SystemException if a system exception occurred
222            */
223            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getBookmarksEntries(
224                    int start, int end)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().getBookmarksEntries(start, end);
227            }
228    
229            /**
230            * Returns the number of bookmarks entries.
231            *
232            * @return the number of bookmarks entries
233            * @throws SystemException if a system exception occurred
234            */
235            public static int getBookmarksEntriesCount()
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().getBookmarksEntriesCount();
238            }
239    
240            /**
241            * Updates the bookmarks entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
242            *
243            * @param bookmarksEntry the bookmarks entry
244            * @return the bookmarks entry that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portlet.bookmarks.model.BookmarksEntry updateBookmarksEntry(
248                    com.liferay.portlet.bookmarks.model.BookmarksEntry bookmarksEntry)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updateBookmarksEntry(bookmarksEntry);
251            }
252    
253            /**
254            * Returns the Spring bean ID for this bean.
255            *
256            * @return the Spring bean ID for this bean
257            */
258            public static java.lang.String getBeanIdentifier() {
259                    return getService().getBeanIdentifier();
260            }
261    
262            /**
263            * Sets the Spring bean ID for this bean.
264            *
265            * @param beanIdentifier the Spring bean ID for this bean
266            */
267            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
268                    getService().setBeanIdentifier(beanIdentifier);
269            }
270    
271            public static com.liferay.portlet.bookmarks.model.BookmarksEntry addEntry(
272                    long userId, long groupId, long folderId, java.lang.String name,
273                    java.lang.String url, java.lang.String description,
274                    com.liferay.portal.service.ServiceContext serviceContext)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException {
277                    return getService()
278                                       .addEntry(userId, groupId, folderId, name, url, description,
279                            serviceContext);
280            }
281    
282            public static void deleteEntries(long groupId, long folderId)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException {
285                    getService().deleteEntries(groupId, folderId);
286            }
287    
288            public static void deleteEntries(long groupId, long folderId,
289                    boolean includeTrashedEntries)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    getService().deleteEntries(groupId, folderId, includeTrashedEntries);
293            }
294    
295            public static com.liferay.portlet.bookmarks.model.BookmarksEntry deleteEntry(
296                    com.liferay.portlet.bookmarks.model.BookmarksEntry entry)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException {
299                    return getService().deleteEntry(entry);
300            }
301    
302            public static com.liferay.portlet.bookmarks.model.BookmarksEntry deleteEntry(
303                    long entryId)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException {
306                    return getService().deleteEntry(entryId);
307            }
308    
309            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getEntries(
310                    long groupId, long folderId, int start, int end)
311                    throws com.liferay.portal.kernel.exception.SystemException {
312                    return getService().getEntries(groupId, folderId, start, end);
313            }
314    
315            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getEntries(
316                    long groupId, long folderId, int start, int end,
317                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
318                    throws com.liferay.portal.kernel.exception.SystemException {
319                    return getService()
320                                       .getEntries(groupId, folderId, start, end, orderByComparator);
321            }
322    
323            public static int getEntriesCount(long groupId, long folderId)
324                    throws com.liferay.portal.kernel.exception.SystemException {
325                    return getService().getEntriesCount(groupId, folderId);
326            }
327    
328            public static com.liferay.portlet.bookmarks.model.BookmarksEntry getEntry(
329                    long entryId)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException {
332                    return getService().getEntry(entryId);
333            }
334    
335            public static int getFoldersEntriesCount(long groupId,
336                    java.util.List<java.lang.Long> folderIds)
337                    throws com.liferay.portal.kernel.exception.SystemException {
338                    return getService().getFoldersEntriesCount(groupId, folderIds);
339            }
340    
341            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getGroupEntries(
342                    long groupId, int start, int end)
343                    throws com.liferay.portal.kernel.exception.SystemException {
344                    return getService().getGroupEntries(groupId, start, end);
345            }
346    
347            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getGroupEntries(
348                    long groupId, long userId, int start, int end)
349                    throws com.liferay.portal.kernel.exception.SystemException {
350                    return getService().getGroupEntries(groupId, userId, start, end);
351            }
352    
353            public static int getGroupEntriesCount(long groupId)
354                    throws com.liferay.portal.kernel.exception.SystemException {
355                    return getService().getGroupEntriesCount(groupId);
356            }
357    
358            public static int getGroupEntriesCount(long groupId, long userId)
359                    throws com.liferay.portal.kernel.exception.SystemException {
360                    return getService().getGroupEntriesCount(groupId, userId);
361            }
362    
363            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getNoAssetEntries()
364                    throws com.liferay.portal.kernel.exception.SystemException {
365                    return getService().getNoAssetEntries();
366            }
367    
368            public static com.liferay.portlet.bookmarks.model.BookmarksEntry moveEntry(
369                    long entryId, long parentFolderId)
370                    throws com.liferay.portal.kernel.exception.PortalException,
371                            com.liferay.portal.kernel.exception.SystemException {
372                    return getService().moveEntry(entryId, parentFolderId);
373            }
374    
375            public static com.liferay.portlet.bookmarks.model.BookmarksEntry moveEntryFromTrash(
376                    long userId, long entryId, long parentFolderId)
377                    throws com.liferay.portal.kernel.exception.PortalException,
378                            com.liferay.portal.kernel.exception.SystemException {
379                    return getService().moveEntryFromTrash(userId, entryId, parentFolderId);
380            }
381    
382            public static com.liferay.portlet.bookmarks.model.BookmarksEntry moveEntryToTrash(
383                    long userId, com.liferay.portlet.bookmarks.model.BookmarksEntry entry)
384                    throws com.liferay.portal.kernel.exception.PortalException,
385                            com.liferay.portal.kernel.exception.SystemException {
386                    return getService().moveEntryToTrash(userId, entry);
387            }
388    
389            public static com.liferay.portlet.bookmarks.model.BookmarksEntry moveEntryToTrash(
390                    long userId, long entryId)
391                    throws com.liferay.portal.kernel.exception.PortalException,
392                            com.liferay.portal.kernel.exception.SystemException {
393                    return getService().moveEntryToTrash(userId, entryId);
394            }
395    
396            public static com.liferay.portlet.bookmarks.model.BookmarksEntry openEntry(
397                    long userId, com.liferay.portlet.bookmarks.model.BookmarksEntry entry)
398                    throws com.liferay.portal.kernel.exception.SystemException {
399                    return getService().openEntry(userId, entry);
400            }
401    
402            public static com.liferay.portlet.bookmarks.model.BookmarksEntry openEntry(
403                    long userId, long entryId)
404                    throws com.liferay.portal.kernel.exception.PortalException,
405                            com.liferay.portal.kernel.exception.SystemException {
406                    return getService().openEntry(userId, entryId);
407            }
408    
409            public static com.liferay.portlet.bookmarks.model.BookmarksEntry restoreEntryFromTrash(
410                    long userId, long entryId)
411                    throws com.liferay.portal.kernel.exception.PortalException,
412                            com.liferay.portal.kernel.exception.SystemException {
413                    return getService().restoreEntryFromTrash(userId, entryId);
414            }
415    
416            public static void subscribeEntry(long userId, long entryId)
417                    throws com.liferay.portal.kernel.exception.PortalException,
418                            com.liferay.portal.kernel.exception.SystemException {
419                    getService().subscribeEntry(userId, entryId);
420            }
421    
422            public static void unsubscribeEntry(long userId, long entryId)
423                    throws com.liferay.portal.kernel.exception.PortalException,
424                            com.liferay.portal.kernel.exception.SystemException {
425                    getService().unsubscribeEntry(userId, entryId);
426            }
427    
428            public static void updateAsset(long userId,
429                    com.liferay.portlet.bookmarks.model.BookmarksEntry entry,
430                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
431                    long[] assetLinkEntryIds)
432                    throws com.liferay.portal.kernel.exception.PortalException,
433                            com.liferay.portal.kernel.exception.SystemException {
434                    getService()
435                            .updateAsset(userId, entry, assetCategoryIds, assetTagNames,
436                            assetLinkEntryIds);
437            }
438    
439            public static com.liferay.portlet.bookmarks.model.BookmarksEntry updateEntry(
440                    long userId, long entryId, long groupId, long folderId,
441                    java.lang.String name, java.lang.String url,
442                    java.lang.String description,
443                    com.liferay.portal.service.ServiceContext serviceContext)
444                    throws com.liferay.portal.kernel.exception.PortalException,
445                            com.liferay.portal.kernel.exception.SystemException {
446                    return getService()
447                                       .updateEntry(userId, entryId, groupId, folderId, name, url,
448                            description, serviceContext);
449            }
450    
451            public static com.liferay.portlet.bookmarks.model.BookmarksEntry updateStatus(
452                    long userId, com.liferay.portlet.bookmarks.model.BookmarksEntry entry,
453                    int status)
454                    throws com.liferay.portal.kernel.exception.PortalException,
455                            com.liferay.portal.kernel.exception.SystemException {
456                    return getService().updateStatus(userId, entry, status);
457            }
458    
459            public static BookmarksEntryLocalService getService() {
460                    if (_service == null) {
461                            _service = (BookmarksEntryLocalService)PortalBeanLocatorUtil.locate(BookmarksEntryLocalService.class.getName());
462    
463                            ReferenceRegistry.registerReference(BookmarksEntryLocalServiceUtil.class,
464                                    "_service");
465                    }
466    
467                    return _service;
468            }
469    
470            /**
471             * @deprecated
472             */
473            public void setService(BookmarksEntryLocalService service) {
474            }
475    
476            private static BookmarksEntryLocalService _service;
477    }