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.bookmarks.service;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.transaction.Isolation;
022    import com.liferay.portal.kernel.transaction.Propagation;
023    import com.liferay.portal.kernel.transaction.Transactional;
024    import com.liferay.portal.service.BaseLocalService;
025    import com.liferay.portal.service.PermissionedModelLocalService;
026    
027    /**
028     * Provides the local service interface for BookmarksEntry. Methods of this
029     * service will not have security checks based on the propagated JAAS
030     * credentials because this service can only be accessed from within the same
031     * VM.
032     *
033     * @author Brian Wing Shun Chan
034     * @see BookmarksEntryLocalServiceUtil
035     * @see com.liferay.portlet.bookmarks.service.base.BookmarksEntryLocalServiceBaseImpl
036     * @see com.liferay.portlet.bookmarks.service.impl.BookmarksEntryLocalServiceImpl
037     * @generated
038     */
039    @ProviderType
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface BookmarksEntryLocalService extends BaseLocalService,
043            PermissionedModelLocalService {
044            /*
045             * NOTE FOR DEVELOPERS:
046             *
047             * Never modify or reference this interface directly. Always use {@link BookmarksEntryLocalServiceUtil} to access the bookmarks entry local service. Add custom service methods to {@link com.liferay.portlet.bookmarks.service.impl.BookmarksEntryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
048             */
049    
050            /**
051            * Adds the bookmarks entry to the database. Also notifies the appropriate model listeners.
052            *
053            * @param bookmarksEntry the bookmarks entry
054            * @return the bookmarks entry that was added
055            * @throws SystemException if a system exception occurred
056            */
057            public com.liferay.portlet.bookmarks.model.BookmarksEntry addBookmarksEntry(
058                    com.liferay.portlet.bookmarks.model.BookmarksEntry bookmarksEntry)
059                    throws com.liferay.portal.kernel.exception.SystemException;
060    
061            /**
062            * Creates a new bookmarks entry with the primary key. Does not add the bookmarks entry to the database.
063            *
064            * @param entryId the primary key for the new bookmarks entry
065            * @return the new bookmarks entry
066            */
067            public com.liferay.portlet.bookmarks.model.BookmarksEntry createBookmarksEntry(
068                    long entryId);
069    
070            /**
071            * Deletes the bookmarks entry with the primary key from the database. Also notifies the appropriate model listeners.
072            *
073            * @param entryId the primary key of the bookmarks entry
074            * @return the bookmarks entry that was removed
075            * @throws PortalException if a bookmarks entry with the primary key could not be found
076            * @throws SystemException if a system exception occurred
077            */
078            public com.liferay.portlet.bookmarks.model.BookmarksEntry deleteBookmarksEntry(
079                    long entryId)
080                    throws com.liferay.portal.kernel.exception.PortalException,
081                            com.liferay.portal.kernel.exception.SystemException;
082    
083            /**
084            * Deletes the bookmarks entry from the database. Also notifies the appropriate model listeners.
085            *
086            * @param bookmarksEntry the bookmarks entry
087            * @return the bookmarks entry that was removed
088            * @throws SystemException if a system exception occurred
089            */
090            public com.liferay.portlet.bookmarks.model.BookmarksEntry deleteBookmarksEntry(
091                    com.liferay.portlet.bookmarks.model.BookmarksEntry bookmarksEntry)
092                    throws com.liferay.portal.kernel.exception.SystemException;
093    
094            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
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 java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException;
107    
108            /**
109            * Performs a dynamic query on the database and returns a range of the matching rows.
110            *
111            * <p>
112            * 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.
113            * </p>
114            *
115            * @param dynamicQuery the dynamic query
116            * @param start the lower bound of the range of model instances
117            * @param end the upper bound of the range of model instances (not inclusive)
118            * @return the range of matching rows
119            * @throws SystemException if a system exception occurred
120            */
121            @SuppressWarnings("rawtypes")
122            public java.util.List dynamicQuery(
123                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
124                    int end) throws com.liferay.portal.kernel.exception.SystemException;
125    
126            /**
127            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
128            *
129            * <p>
130            * 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.
131            * </p>
132            *
133            * @param dynamicQuery the dynamic query
134            * @param start the lower bound of the range of model instances
135            * @param end the upper bound of the range of model instances (not inclusive)
136            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
137            * @return the ordered range of matching rows
138            * @throws SystemException if a system exception occurred
139            */
140            @SuppressWarnings("rawtypes")
141            public java.util.List dynamicQuery(
142                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
143                    int end,
144                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
145                    throws com.liferay.portal.kernel.exception.SystemException;
146    
147            /**
148            * Returns the number of rows that match the dynamic query.
149            *
150            * @param dynamicQuery the dynamic query
151            * @return the number of rows that match the dynamic query
152            * @throws SystemException if a system exception occurred
153            */
154            public long dynamicQueryCount(
155                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
156                    throws com.liferay.portal.kernel.exception.SystemException;
157    
158            /**
159            * Returns the number of rows that match the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @param projection the projection to apply to the query
163            * @return the number of rows that match the dynamic query
164            * @throws SystemException if a system exception occurred
165            */
166            public long dynamicQueryCount(
167                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
168                    com.liferay.portal.kernel.dao.orm.Projection projection)
169                    throws com.liferay.portal.kernel.exception.SystemException;
170    
171            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
172            public com.liferay.portlet.bookmarks.model.BookmarksEntry fetchBookmarksEntry(
173                    long entryId)
174                    throws com.liferay.portal.kernel.exception.SystemException;
175    
176            /**
177            * Returns the bookmarks entry with the matching UUID and company.
178            *
179            * @param uuid the bookmarks entry's UUID
180            * @param companyId the primary key of the company
181            * @return the matching bookmarks entry, or <code>null</code> if a matching bookmarks entry could not be found
182            * @throws SystemException if a system exception occurred
183            */
184            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185            public com.liferay.portlet.bookmarks.model.BookmarksEntry fetchBookmarksEntryByUuidAndCompanyId(
186                    java.lang.String uuid, long companyId)
187                    throws com.liferay.portal.kernel.exception.SystemException;
188    
189            /**
190            * Returns the bookmarks entry matching the UUID and group.
191            *
192            * @param uuid the bookmarks entry's UUID
193            * @param groupId the primary key of the group
194            * @return the matching bookmarks entry, or <code>null</code> if a matching bookmarks entry could not be found
195            * @throws SystemException if a system exception occurred
196            */
197            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
198            public com.liferay.portlet.bookmarks.model.BookmarksEntry fetchBookmarksEntryByUuidAndGroupId(
199                    java.lang.String uuid, long groupId)
200                    throws com.liferay.portal.kernel.exception.SystemException;
201    
202            /**
203            * Returns the bookmarks entry with the primary key.
204            *
205            * @param entryId the primary key of the bookmarks entry
206            * @return the bookmarks entry
207            * @throws PortalException if a bookmarks entry with the primary key could not be found
208            * @throws SystemException if a system exception occurred
209            */
210            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
211            public com.liferay.portlet.bookmarks.model.BookmarksEntry getBookmarksEntry(
212                    long entryId)
213                    throws com.liferay.portal.kernel.exception.PortalException,
214                            com.liferay.portal.kernel.exception.SystemException;
215    
216            @Override
217            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
218            public com.liferay.portal.model.PersistedModel getPersistedModel(
219                    java.io.Serializable primaryKeyObj)
220                    throws com.liferay.portal.kernel.exception.PortalException,
221                            com.liferay.portal.kernel.exception.SystemException;
222    
223            /**
224            * Returns the bookmarks entry with the matching UUID and company.
225            *
226            * @param uuid the bookmarks entry's UUID
227            * @param companyId the primary key of the company
228            * @return the matching bookmarks entry
229            * @throws PortalException if a matching bookmarks entry could not be found
230            * @throws SystemException if a system exception occurred
231            */
232            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
233            public com.liferay.portlet.bookmarks.model.BookmarksEntry getBookmarksEntryByUuidAndCompanyId(
234                    java.lang.String uuid, long companyId)
235                    throws com.liferay.portal.kernel.exception.PortalException,
236                            com.liferay.portal.kernel.exception.SystemException;
237    
238            /**
239            * Returns the bookmarks entry matching the UUID and group.
240            *
241            * @param uuid the bookmarks entry's UUID
242            * @param groupId the primary key of the group
243            * @return the matching bookmarks entry
244            * @throws PortalException if a matching bookmarks entry could not be found
245            * @throws SystemException if a system exception occurred
246            */
247            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
248            public com.liferay.portlet.bookmarks.model.BookmarksEntry getBookmarksEntryByUuidAndGroupId(
249                    java.lang.String uuid, long groupId)
250                    throws com.liferay.portal.kernel.exception.PortalException,
251                            com.liferay.portal.kernel.exception.SystemException;
252    
253            /**
254            * Returns a range of all the bookmarks entries.
255            *
256            * <p>
257            * 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.
258            * </p>
259            *
260            * @param start the lower bound of the range of bookmarks entries
261            * @param end the upper bound of the range of bookmarks entries (not inclusive)
262            * @return the range of bookmarks entries
263            * @throws SystemException if a system exception occurred
264            */
265            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
266            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getBookmarksEntries(
267                    int start, int end)
268                    throws com.liferay.portal.kernel.exception.SystemException;
269    
270            /**
271            * Returns the number of bookmarks entries.
272            *
273            * @return the number of bookmarks entries
274            * @throws SystemException if a system exception occurred
275            */
276            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
277            public int getBookmarksEntriesCount()
278                    throws com.liferay.portal.kernel.exception.SystemException;
279    
280            /**
281            * Updates the bookmarks entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
282            *
283            * @param bookmarksEntry the bookmarks entry
284            * @return the bookmarks entry that was updated
285            * @throws SystemException if a system exception occurred
286            */
287            public com.liferay.portlet.bookmarks.model.BookmarksEntry updateBookmarksEntry(
288                    com.liferay.portlet.bookmarks.model.BookmarksEntry bookmarksEntry)
289                    throws com.liferay.portal.kernel.exception.SystemException;
290    
291            /**
292            * Returns the Spring bean ID for this bean.
293            *
294            * @return the Spring bean ID for this bean
295            */
296            public java.lang.String getBeanIdentifier();
297    
298            /**
299            * Sets the Spring bean ID for this bean.
300            *
301            * @param beanIdentifier the Spring bean ID for this bean
302            */
303            public void setBeanIdentifier(java.lang.String beanIdentifier);
304    
305            public com.liferay.portlet.bookmarks.model.BookmarksEntry addEntry(
306                    long userId, long groupId, long folderId, java.lang.String name,
307                    java.lang.String url, java.lang.String description,
308                    com.liferay.portal.service.ServiceContext serviceContext)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException;
311    
312            public void deleteEntries(long groupId, long folderId)
313                    throws com.liferay.portal.kernel.exception.PortalException,
314                            com.liferay.portal.kernel.exception.SystemException;
315    
316            public void deleteEntries(long groupId, long folderId,
317                    boolean includeTrashedEntries)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException;
320    
321            public com.liferay.portlet.bookmarks.model.BookmarksEntry deleteEntry(
322                    com.liferay.portlet.bookmarks.model.BookmarksEntry entry)
323                    throws com.liferay.portal.kernel.exception.PortalException,
324                            com.liferay.portal.kernel.exception.SystemException;
325    
326            public com.liferay.portlet.bookmarks.model.BookmarksEntry deleteEntry(
327                    long entryId)
328                    throws com.liferay.portal.kernel.exception.PortalException,
329                            com.liferay.portal.kernel.exception.SystemException;
330    
331            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
332            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getEntries(
333                    long groupId, long folderId, int start, int end)
334                    throws com.liferay.portal.kernel.exception.SystemException;
335    
336            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
337            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getEntries(
338                    long groupId, long folderId, int status, int start, int end)
339                    throws com.liferay.portal.kernel.exception.SystemException;
340    
341            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
342            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getEntries(
343                    long groupId, long folderId, int start, int end,
344                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
345                    throws com.liferay.portal.kernel.exception.SystemException;
346    
347            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
348            public int getEntriesCount(long groupId, long folderId)
349                    throws com.liferay.portal.kernel.exception.SystemException;
350    
351            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
352            public int getEntriesCount(long groupId, long folderId, int status)
353                    throws com.liferay.portal.kernel.exception.SystemException;
354    
355            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
356            public com.liferay.portlet.bookmarks.model.BookmarksEntry getEntry(
357                    long entryId)
358                    throws com.liferay.portal.kernel.exception.PortalException,
359                            com.liferay.portal.kernel.exception.SystemException;
360    
361            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
362            public int getFoldersEntriesCount(long groupId,
363                    java.util.List<java.lang.Long> folderIds)
364                    throws com.liferay.portal.kernel.exception.SystemException;
365    
366            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
367            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getGroupEntries(
368                    long groupId, int start, int end)
369                    throws com.liferay.portal.kernel.exception.SystemException;
370    
371            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
372            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getGroupEntries(
373                    long groupId, long userId, int start, int end)
374                    throws com.liferay.portal.kernel.exception.SystemException;
375    
376            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
377            public int getGroupEntriesCount(long groupId)
378                    throws com.liferay.portal.kernel.exception.SystemException;
379    
380            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
381            public int getGroupEntriesCount(long groupId, long userId)
382                    throws com.liferay.portal.kernel.exception.SystemException;
383    
384            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
385            public java.util.List<com.liferay.portlet.bookmarks.model.BookmarksEntry> getNoAssetEntries()
386                    throws com.liferay.portal.kernel.exception.SystemException;
387    
388            public com.liferay.portlet.bookmarks.model.BookmarksEntry moveEntry(
389                    long entryId, long parentFolderId)
390                    throws com.liferay.portal.kernel.exception.PortalException,
391                            com.liferay.portal.kernel.exception.SystemException;
392    
393            public com.liferay.portlet.bookmarks.model.BookmarksEntry moveEntryFromTrash(
394                    long userId, long entryId, long parentFolderId)
395                    throws com.liferay.portal.kernel.exception.PortalException,
396                            com.liferay.portal.kernel.exception.SystemException;
397    
398            public com.liferay.portlet.bookmarks.model.BookmarksEntry moveEntryToTrash(
399                    long userId, com.liferay.portlet.bookmarks.model.BookmarksEntry entry)
400                    throws com.liferay.portal.kernel.exception.PortalException,
401                            com.liferay.portal.kernel.exception.SystemException;
402    
403            public com.liferay.portlet.bookmarks.model.BookmarksEntry moveEntryToTrash(
404                    long userId, long entryId)
405                    throws com.liferay.portal.kernel.exception.PortalException,
406                            com.liferay.portal.kernel.exception.SystemException;
407    
408            public com.liferay.portlet.bookmarks.model.BookmarksEntry openEntry(
409                    long userId, com.liferay.portlet.bookmarks.model.BookmarksEntry entry)
410                    throws com.liferay.portal.kernel.exception.SystemException;
411    
412            public com.liferay.portlet.bookmarks.model.BookmarksEntry openEntry(
413                    long userId, long entryId)
414                    throws com.liferay.portal.kernel.exception.PortalException,
415                            com.liferay.portal.kernel.exception.SystemException;
416    
417            public void rebuildTree(long companyId)
418                    throws com.liferay.portal.kernel.exception.SystemException;
419    
420            public com.liferay.portlet.bookmarks.model.BookmarksEntry restoreEntryFromTrash(
421                    long userId, long entryId)
422                    throws com.liferay.portal.kernel.exception.PortalException,
423                            com.liferay.portal.kernel.exception.SystemException;
424    
425            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
426            public com.liferay.portal.kernel.search.Hits search(long groupId,
427                    long userId, long creatorUserId, int status, int start, int end)
428                    throws com.liferay.portal.kernel.exception.PortalException,
429                            com.liferay.portal.kernel.exception.SystemException;
430    
431            public void subscribeEntry(long userId, long entryId)
432                    throws com.liferay.portal.kernel.exception.PortalException,
433                            com.liferay.portal.kernel.exception.SystemException;
434    
435            public void unsubscribeEntry(long userId, long entryId)
436                    throws com.liferay.portal.kernel.exception.PortalException,
437                            com.liferay.portal.kernel.exception.SystemException;
438    
439            public void updateAsset(long userId,
440                    com.liferay.portlet.bookmarks.model.BookmarksEntry entry,
441                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
442                    long[] assetLinkEntryIds)
443                    throws com.liferay.portal.kernel.exception.PortalException,
444                            com.liferay.portal.kernel.exception.SystemException;
445    
446            public com.liferay.portlet.bookmarks.model.BookmarksEntry updateEntry(
447                    long userId, long entryId, long groupId, long folderId,
448                    java.lang.String name, java.lang.String url,
449                    java.lang.String description,
450                    com.liferay.portal.service.ServiceContext serviceContext)
451                    throws com.liferay.portal.kernel.exception.PortalException,
452                            com.liferay.portal.kernel.exception.SystemException;
453    
454            public com.liferay.portlet.bookmarks.model.BookmarksEntry updateStatus(
455                    long userId, com.liferay.portlet.bookmarks.model.BookmarksEntry entry,
456                    int status)
457                    throws com.liferay.portal.kernel.exception.PortalException,
458                            com.liferay.portal.kernel.exception.SystemException;
459    }