001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * 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.
023     *
024     * <p>
025     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see BookmarksEntryLocalService
030     * @see com.liferay.portlet.bookmarks.service.base.BookmarksEntryLocalServiceBaseImpl
031     * @see com.liferay.portlet.bookmarks.service.impl.BookmarksEntryLocalServiceImpl
032     * @generated
033     */
034    public class BookmarksEntryLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * 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.
039             */
040    
041            /**
042            * Adds the bookmarks entry to the database. Also notifies the appropriate model listeners.
043            *
044            * @param bookmarksEntry the bookmarks entry
045            * @return the bookmarks entry that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.bookmarks.model.BookmarksEntry addBookmarksEntry(
049                    com.liferay.portlet.bookmarks.model.BookmarksEntry bookmarksEntry)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addBookmarksEntry(bookmarksEntry);
052            }
053    
054            /**
055            * Creates a new bookmarks entry with the primary key. Does not add the bookmarks entry to the database.
056            *
057            * @param entryId the primary key for the new bookmarks entry
058            * @return the new bookmarks entry
059            */
060            public static com.liferay.portlet.bookmarks.model.BookmarksEntry createBookmarksEntry(
061                    long entryId) {
062                    return getService().createBookmarksEntry(entryId);
063            }
064    
065            /**
066            * Deletes the bookmarks entry with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param entryId the primary key of the bookmarks entry
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 void deleteBookmarksEntry(long entryId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteBookmarksEntry(entryId);
076            }
077    
078            /**
079            * Deletes the bookmarks entry from the database. Also notifies the appropriate model listeners.
080            *
081            * @param bookmarksEntry the bookmarks entry
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteBookmarksEntry(
085                    com.liferay.portlet.bookmarks.model.BookmarksEntry bookmarksEntry)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteBookmarksEntry(bookmarksEntry);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            /**
162            * Returns the bookmarks entry with the primary key.
163            *
164            * @param entryId the primary key of the bookmarks entry
165            * @return the bookmarks entry
166            * @throws PortalException if a bookmarks entry with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portlet.bookmarks.model.BookmarksEntry getBookmarksEntry(
170                    long entryId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getBookmarksEntry(entryId);
174            }
175    
176            public static com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return getService().getPersistedModel(primaryKeyObj);
181            }
182    
183            /**
184            * Returns the bookmarks entry with the UUID in the group.
185            *
186            * @param uuid the UUID of bookmarks entry
187            * @param groupId the group id of the bookmarks entry
188            * @return the bookmarks entry
189            * @throws PortalException if a bookmarks entry with the UUID in the group could not be found
190            * @throws SystemException if a system exception occurred
191            */
192            public static com.liferay.portlet.bookmarks.model.BookmarksEntry getBookmarksEntryByUuidAndGroupId(
193                    java.lang.String uuid, long groupId)
194                    throws com.liferay.portal.kernel.exception.PortalException,
195                            com.liferay.portal.kernel.exception.SystemException {
196                    return getService().getBookmarksEntryByUuidAndGroupId(uuid, groupId);
197            }
198    
199            /**
200            * Returns a range of all the bookmarks entries.
201            *
202            * <p>
203            * 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.
204            * </p>
205            *
206            * @param start the lower bound of the range of bookmarks entries
207            * @param end the upper bound of the range of bookmarks entries (not inclusive)
208            * @return the range of bookmarks entries
209            * @throws SystemException if a system exception occurred
210            */
211            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getBookmarksEntries(
212                    int start, int end)
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getBookmarksEntries(start, end);
215            }
216    
217            /**
218            * Returns the number of bookmarks entries.
219            *
220            * @return the number of bookmarks entries
221            * @throws SystemException if a system exception occurred
222            */
223            public static int getBookmarksEntriesCount()
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().getBookmarksEntriesCount();
226            }
227    
228            /**
229            * Updates the bookmarks entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
230            *
231            * @param bookmarksEntry the bookmarks entry
232            * @return the bookmarks entry that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public static com.liferay.portlet.bookmarks.model.BookmarksEntry updateBookmarksEntry(
236                    com.liferay.portlet.bookmarks.model.BookmarksEntry bookmarksEntry)
237                    throws com.liferay.portal.kernel.exception.SystemException {
238                    return getService().updateBookmarksEntry(bookmarksEntry);
239            }
240    
241            /**
242            * Updates the bookmarks entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
243            *
244            * @param bookmarksEntry the bookmarks entry
245            * @param merge whether to merge the bookmarks entry 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.
246            * @return the bookmarks entry that was updated
247            * @throws SystemException if a system exception occurred
248            */
249            public static com.liferay.portlet.bookmarks.model.BookmarksEntry updateBookmarksEntry(
250                    com.liferay.portlet.bookmarks.model.BookmarksEntry bookmarksEntry,
251                    boolean merge)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    return getService().updateBookmarksEntry(bookmarksEntry, merge);
254            }
255    
256            /**
257            * Returns the Spring bean ID for this bean.
258            *
259            * @return the Spring bean ID for this bean
260            */
261            public static java.lang.String getBeanIdentifier() {
262                    return getService().getBeanIdentifier();
263            }
264    
265            /**
266            * Sets the Spring bean ID for this bean.
267            *
268            * @param beanIdentifier the Spring bean ID for this bean
269            */
270            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
271                    getService().setBeanIdentifier(beanIdentifier);
272            }
273    
274            public static com.liferay.portlet.bookmarks.model.BookmarksEntry addEntry(
275                    long userId, long groupId, long folderId, java.lang.String name,
276                    java.lang.String url, java.lang.String description,
277                    com.liferay.portal.service.ServiceContext serviceContext)
278                    throws com.liferay.portal.kernel.exception.PortalException,
279                            com.liferay.portal.kernel.exception.SystemException {
280                    return getService()
281                                       .addEntry(userId, groupId, folderId, name, url, description,
282                            serviceContext);
283            }
284    
285            public static void addEntryResources(
286                    com.liferay.portlet.bookmarks.model.BookmarksEntry entry,
287                    boolean addCommunityPermissions, boolean addGuestPermissions)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException {
290                    getService()
291                            .addEntryResources(entry, addCommunityPermissions,
292                            addGuestPermissions);
293            }
294    
295            public static void addEntryResources(
296                    com.liferay.portlet.bookmarks.model.BookmarksEntry entry,
297                    java.lang.String[] communityPermissions,
298                    java.lang.String[] guestPermissions)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException {
301                    getService()
302                            .addEntryResources(entry, communityPermissions, guestPermissions);
303            }
304    
305            public static void addEntryResources(long entryId,
306                    boolean addCommunityPermissions, boolean addGuestPermissions)
307                    throws com.liferay.portal.kernel.exception.PortalException,
308                            com.liferay.portal.kernel.exception.SystemException {
309                    getService()
310                            .addEntryResources(entryId, addCommunityPermissions,
311                            addGuestPermissions);
312            }
313    
314            public static void addEntryResources(long entryId,
315                    java.lang.String[] communityPermissions,
316                    java.lang.String[] guestPermissions)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException {
319                    getService()
320                            .addEntryResources(entryId, communityPermissions, guestPermissions);
321            }
322    
323            public static void deleteEntries(long groupId, long folderId)
324                    throws com.liferay.portal.kernel.exception.PortalException,
325                            com.liferay.portal.kernel.exception.SystemException {
326                    getService().deleteEntries(groupId, folderId);
327            }
328    
329            public static void deleteEntry(
330                    com.liferay.portlet.bookmarks.model.BookmarksEntry entry)
331                    throws com.liferay.portal.kernel.exception.PortalException,
332                            com.liferay.portal.kernel.exception.SystemException {
333                    getService().deleteEntry(entry);
334            }
335    
336            public static void deleteEntry(long entryId)
337                    throws com.liferay.portal.kernel.exception.PortalException,
338                            com.liferay.portal.kernel.exception.SystemException {
339                    getService().deleteEntry(entryId);
340            }
341    
342            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getEntries(
343                    long groupId, long folderId, int start, int end)
344                    throws com.liferay.portal.kernel.exception.SystemException {
345                    return getService().getEntries(groupId, folderId, start, end);
346            }
347    
348            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getEntries(
349                    long groupId, long folderId, int start, int end,
350                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
351                    throws com.liferay.portal.kernel.exception.SystemException {
352                    return getService()
353                                       .getEntries(groupId, folderId, start, end, orderByComparator);
354            }
355    
356            public static int getEntriesCount(long groupId, long folderId)
357                    throws com.liferay.portal.kernel.exception.SystemException {
358                    return getService().getEntriesCount(groupId, folderId);
359            }
360    
361            public static com.liferay.portlet.bookmarks.model.BookmarksEntry getEntry(
362                    long entryId)
363                    throws com.liferay.portal.kernel.exception.PortalException,
364                            com.liferay.portal.kernel.exception.SystemException {
365                    return getService().getEntry(entryId);
366            }
367    
368            public static int getFoldersEntriesCount(long groupId,
369                    java.util.List<java.lang.Long> folderIds)
370                    throws com.liferay.portal.kernel.exception.SystemException {
371                    return getService().getFoldersEntriesCount(groupId, folderIds);
372            }
373    
374            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getGroupEntries(
375                    long groupId, int start, int end)
376                    throws com.liferay.portal.kernel.exception.SystemException {
377                    return getService().getGroupEntries(groupId, start, end);
378            }
379    
380            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getGroupEntries(
381                    long groupId, long userId, int start, int end)
382                    throws com.liferay.portal.kernel.exception.SystemException {
383                    return getService().getGroupEntries(groupId, userId, start, end);
384            }
385    
386            public static int getGroupEntriesCount(long groupId)
387                    throws com.liferay.portal.kernel.exception.SystemException {
388                    return getService().getGroupEntriesCount(groupId);
389            }
390    
391            public static int getGroupEntriesCount(long groupId, long userId)
392                    throws com.liferay.portal.kernel.exception.SystemException {
393                    return getService().getGroupEntriesCount(groupId, userId);
394            }
395    
396            public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getNoAssetEntries()
397                    throws com.liferay.portal.kernel.exception.SystemException {
398                    return getService().getNoAssetEntries();
399            }
400    
401            public static com.liferay.portlet.bookmarks.model.BookmarksEntry openEntry(
402                    long userId, long entryId)
403                    throws com.liferay.portal.kernel.exception.PortalException,
404                            com.liferay.portal.kernel.exception.SystemException {
405                    return getService().openEntry(userId, entryId);
406            }
407    
408            public static void updateAsset(long userId,
409                    com.liferay.portlet.bookmarks.model.BookmarksEntry entry,
410                    long[] assetCategoryIds, java.lang.String[] assetTagNames)
411                    throws com.liferay.portal.kernel.exception.PortalException,
412                            com.liferay.portal.kernel.exception.SystemException {
413                    getService().updateAsset(userId, entry, assetCategoryIds, assetTagNames);
414            }
415    
416            public static com.liferay.portlet.bookmarks.model.BookmarksEntry updateEntry(
417                    long userId, long entryId, long groupId, long folderId,
418                    java.lang.String name, java.lang.String url,
419                    java.lang.String description,
420                    com.liferay.portal.service.ServiceContext serviceContext)
421                    throws com.liferay.portal.kernel.exception.PortalException,
422                            com.liferay.portal.kernel.exception.SystemException {
423                    return getService()
424                                       .updateEntry(userId, entryId, groupId, folderId, name, url,
425                            description, serviceContext);
426            }
427    
428            public static BookmarksEntryLocalService getService() {
429                    if (_service == null) {
430                            _service = (BookmarksEntryLocalService)PortalBeanLocatorUtil.locate(BookmarksEntryLocalService.class.getName());
431    
432                            ReferenceRegistry.registerReference(BookmarksEntryLocalServiceUtil.class,
433                                    "_service");
434                            MethodCache.remove(BookmarksEntryLocalService.class);
435                    }
436    
437                    return _service;
438            }
439    
440            public void setService(BookmarksEntryLocalService service) {
441                    MethodCache.remove(BookmarksEntryLocalService.class);
442    
443                    _service = service;
444    
445                    ReferenceRegistry.registerReference(BookmarksEntryLocalServiceUtil.class,
446                            "_service");
447                    MethodCache.remove(BookmarksEntryLocalService.class);
448            }
449    
450            private static BookmarksEntryLocalService _service;
451    }