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.trash.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.search.IndexableType;
022    import com.liferay.portal.kernel.transaction.Isolation;
023    import com.liferay.portal.kernel.transaction.Propagation;
024    import com.liferay.portal.kernel.transaction.Transactional;
025    import com.liferay.portal.service.BaseLocalService;
026    import com.liferay.portal.service.PersistedModelLocalService;
027    
028    /**
029     * Provides the local service interface for TrashEntry. Methods of this
030     * service will not have security checks based on the propagated JAAS
031     * credentials because this service can only be accessed from within the same
032     * VM.
033     *
034     * @author Brian Wing Shun Chan
035     * @see TrashEntryLocalServiceUtil
036     * @see com.liferay.portlet.trash.service.base.TrashEntryLocalServiceBaseImpl
037     * @see com.liferay.portlet.trash.service.impl.TrashEntryLocalServiceImpl
038     * @generated
039     */
040    @ProviderType
041    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
042            PortalException.class, SystemException.class})
043    public interface TrashEntryLocalService extends BaseLocalService,
044            PersistedModelLocalService {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. Always use {@link TrashEntryLocalServiceUtil} to access the trash entry local service. Add custom service methods to {@link com.liferay.portlet.trash.service.impl.TrashEntryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
049             */
050    
051            /**
052            * Adds the trash entry to the database. Also notifies the appropriate model listeners.
053            *
054            * @param trashEntry the trash entry
055            * @return the trash entry that was added
056            * @throws SystemException if a system exception occurred
057            */
058            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
059            public com.liferay.portlet.trash.model.TrashEntry addTrashEntry(
060                    com.liferay.portlet.trash.model.TrashEntry trashEntry)
061                    throws com.liferay.portal.kernel.exception.SystemException;
062    
063            /**
064            * Creates a new trash entry with the primary key. Does not add the trash entry to the database.
065            *
066            * @param entryId the primary key for the new trash entry
067            * @return the new trash entry
068            */
069            public com.liferay.portlet.trash.model.TrashEntry createTrashEntry(
070                    long entryId);
071    
072            /**
073            * Deletes the trash entry with the primary key from the database. Also notifies the appropriate model listeners.
074            *
075            * @param entryId the primary key of the trash entry
076            * @return the trash entry that was removed
077            * @throws PortalException if a trash entry with the primary key could not be found
078            * @throws SystemException if a system exception occurred
079            */
080            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
081            public com.liferay.portlet.trash.model.TrashEntry deleteTrashEntry(
082                    long entryId)
083                    throws com.liferay.portal.kernel.exception.PortalException,
084                            com.liferay.portal.kernel.exception.SystemException;
085    
086            /**
087            * Deletes the trash entry from the database. Also notifies the appropriate model listeners.
088            *
089            * @param trashEntry the trash entry
090            * @return the trash entry that was removed
091            * @throws SystemException if a system exception occurred
092            */
093            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
094            public com.liferay.portlet.trash.model.TrashEntry deleteTrashEntry(
095                    com.liferay.portlet.trash.model.TrashEntry trashEntry)
096                    throws com.liferay.portal.kernel.exception.SystemException;
097    
098            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
099    
100            /**
101            * Performs a dynamic query on the database and returns the matching rows.
102            *
103            * @param dynamicQuery the dynamic query
104            * @return the matching rows
105            * @throws SystemException if a system exception occurred
106            */
107            @SuppressWarnings("rawtypes")
108            public java.util.List dynamicQuery(
109                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
110                    throws com.liferay.portal.kernel.exception.SystemException;
111    
112            /**
113            * Performs a dynamic query on the database and returns a range of the matching rows.
114            *
115            * <p>
116            * 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.trash.model.impl.TrashEntryModelImpl}. 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.
117            * </p>
118            *
119            * @param dynamicQuery the dynamic query
120            * @param start the lower bound of the range of model instances
121            * @param end the upper bound of the range of model instances (not inclusive)
122            * @return the range of matching rows
123            * @throws SystemException if a system exception occurred
124            */
125            @SuppressWarnings("rawtypes")
126            public java.util.List dynamicQuery(
127                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
128                    int end) throws com.liferay.portal.kernel.exception.SystemException;
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.trash.model.impl.TrashEntryModelImpl}. 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 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    
151            /**
152            * Returns the number of rows that match the dynamic query.
153            *
154            * @param dynamicQuery the dynamic query
155            * @return the number of rows that match the dynamic query
156            * @throws SystemException if a system exception occurred
157            */
158            public long dynamicQueryCount(
159                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
160                    throws com.liferay.portal.kernel.exception.SystemException;
161    
162            /**
163            * Returns the number of rows that match the dynamic query.
164            *
165            * @param dynamicQuery the dynamic query
166            * @param projection the projection to apply to the query
167            * @return the number of rows that match the dynamic query
168            * @throws SystemException if a system exception occurred
169            */
170            public long dynamicQueryCount(
171                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
172                    com.liferay.portal.kernel.dao.orm.Projection projection)
173                    throws com.liferay.portal.kernel.exception.SystemException;
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public com.liferay.portlet.trash.model.TrashEntry fetchTrashEntry(
177                    long entryId)
178                    throws com.liferay.portal.kernel.exception.SystemException;
179    
180            /**
181            * Returns the trash entry with the primary key.
182            *
183            * @param entryId the primary key of the trash entry
184            * @return the trash entry
185            * @throws PortalException if a trash entry with the primary key could not be found
186            * @throws SystemException if a system exception occurred
187            */
188            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
189            public com.liferay.portlet.trash.model.TrashEntry getTrashEntry(
190                    long entryId)
191                    throws com.liferay.portal.kernel.exception.PortalException,
192                            com.liferay.portal.kernel.exception.SystemException;
193    
194            @Override
195            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
196            public com.liferay.portal.model.PersistedModel getPersistedModel(
197                    java.io.Serializable primaryKeyObj)
198                    throws com.liferay.portal.kernel.exception.PortalException,
199                            com.liferay.portal.kernel.exception.SystemException;
200    
201            /**
202            * Returns a range of all the trash entries.
203            *
204            * <p>
205            * 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.trash.model.impl.TrashEntryModelImpl}. 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.
206            * </p>
207            *
208            * @param start the lower bound of the range of trash entries
209            * @param end the upper bound of the range of trash entries (not inclusive)
210            * @return the range of trash entries
211            * @throws SystemException if a system exception occurred
212            */
213            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
214            public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getTrashEntries(
215                    int start, int end)
216                    throws com.liferay.portal.kernel.exception.SystemException;
217    
218            /**
219            * Returns the number of trash entries.
220            *
221            * @return the number of trash entries
222            * @throws SystemException if a system exception occurred
223            */
224            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
225            public int getTrashEntriesCount()
226                    throws com.liferay.portal.kernel.exception.SystemException;
227    
228            /**
229            * Updates the trash entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
230            *
231            * @param trashEntry the trash entry
232            * @return the trash entry that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
236            public com.liferay.portlet.trash.model.TrashEntry updateTrashEntry(
237                    com.liferay.portlet.trash.model.TrashEntry trashEntry)
238                    throws com.liferay.portal.kernel.exception.SystemException;
239    
240            /**
241            * Returns the Spring bean ID for this bean.
242            *
243            * @return the Spring bean ID for this bean
244            */
245            public java.lang.String getBeanIdentifier();
246    
247            /**
248            * Sets the Spring bean ID for this bean.
249            *
250            * @param beanIdentifier the Spring bean ID for this bean
251            */
252            public void setBeanIdentifier(java.lang.String beanIdentifier);
253    
254            /**
255            * Moves an entry to trash.
256            *
257            * @param userId the primary key of the user removing the entity
258            * @param groupId the primary key of the entry's group
259            * @param className the class name of the entity
260            * @param classPK the primary key of the entity
261            * @param status the status of the entity prior to being moved to trash
262            * @param statusOVPs the primary keys and statuses of any of the entry's
263            versions (e.g., {@link
264            com.liferay.portlet.documentlibrary.model.DLFileVersion})
265            * @param typeSettingsProperties the type settings properties
266            * @return the trashEntry
267            * @throws PortalException if a user with the primary key could not be found
268            * @throws SystemException if a system exception occurred
269            */
270            public com.liferay.portlet.trash.model.TrashEntry addTrashEntry(
271                    long userId, long groupId, java.lang.String className, long classPK,
272                    java.lang.String classUuid, java.lang.String referrerClassName,
273                    int status,
274                    java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.Long, java.lang.Integer>> statusOVPs,
275                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties)
276                    throws com.liferay.portal.kernel.exception.PortalException,
277                            com.liferay.portal.kernel.exception.SystemException;
278    
279            public void checkEntries()
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException;
282    
283            public void deleteEntries(long groupId)
284                    throws com.liferay.portal.kernel.exception.SystemException;
285    
286            /**
287            * Deletes the trash entry with the primary key.
288            *
289            * @param entryId the primary key of the trash entry
290            * @return the trash entry with the primary key
291            * @throws PortalException if a trash entry with the primary key could not
292            be found
293            * @throws SystemException if a system exception occurred
294            */
295            public com.liferay.portlet.trash.model.TrashEntry deleteEntry(long entryId)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException;
298    
299            /**
300            * Deletes the trash entry with the entity class name and primary key.
301            *
302            * @param className the class name of entity
303            * @param classPK the primary key of the entry
304            * @return the trash entry with the entity class name and primary key
305            * @throws PortalException if a trash entry with the primary key could not
306            be found
307            * @throws SystemException if a system exception occurred
308            */
309            public com.liferay.portlet.trash.model.TrashEntry deleteEntry(
310                    java.lang.String className, long classPK)
311                    throws com.liferay.portal.kernel.exception.PortalException,
312                            com.liferay.portal.kernel.exception.SystemException;
313    
314            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
315            public com.liferay.portlet.trash.model.TrashEntry deleteEntry(
316                    com.liferay.portlet.trash.model.TrashEntry trashEntry)
317                    throws com.liferay.portal.kernel.exception.SystemException;
318    
319            /**
320            * Returns the trash entry with the primary key.
321            *
322            * @param entryId the primary key of the entry
323            * @return the trash entry with the primary key
324            * @throws SystemException if a system exception occurred
325            */
326            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
327            public com.liferay.portlet.trash.model.TrashEntry fetchEntry(long entryId)
328                    throws com.liferay.portal.kernel.exception.SystemException;
329    
330            /**
331            * Returns the trash entry with the entity class name and primary key.
332            *
333            * @param className the class name of the entity
334            * @param classPK the primary key of the entity
335            * @return the trash entry with the entity class name and primary key
336            * @throws SystemException if a system exception occurred
337            */
338            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
339            public com.liferay.portlet.trash.model.TrashEntry fetchEntry(
340                    java.lang.String className, long classPK)
341                    throws com.liferay.portal.kernel.exception.SystemException;
342    
343            /**
344            * Returns the trash entries with the matching group ID.
345            *
346            * @param groupId the primary key of the group
347            * @return the trash entries with the group ID
348            * @throws SystemException if a system exception occurred
349            */
350            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
351            public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries(
352                    long groupId)
353                    throws com.liferay.portal.kernel.exception.SystemException;
354    
355            /**
356            * Returns a range of all the trash entries matching the group ID.
357            *
358            * @param groupId the primary key of the group
359            * @param start the lower bound of the range of trash entries to return
360            * @param end the upper bound of the range of trash entries to return (not
361            inclusive)
362            * @return the range of matching trash entries
363            * @throws SystemException if a system exception occurred
364            */
365            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
366            public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries(
367                    long groupId, int start, int end)
368                    throws com.liferay.portal.kernel.exception.SystemException;
369    
370            /**
371            * Returns a range of all the trash entries matching the group ID.
372            *
373            * @param groupId the primary key of the group
374            * @param start the lower bound of the range of trash entries to return
375            * @param end the upper bound of the range of trash entries to return (not
376            inclusive)
377            * @param obc the comparator to order the trash entries (optionally
378            <code>null</code>)
379            * @return the range of matching trash entries ordered by comparator
380            <code>obc</code>
381            * @throws SystemException if a system exception occurred
382            */
383            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
384            public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries(
385                    long groupId, int start, int end,
386                    com.liferay.portal.kernel.util.OrderByComparator obc)
387                    throws com.liferay.portal.kernel.exception.SystemException;
388    
389            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
390            public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries(
391                    long groupId, java.lang.String className)
392                    throws com.liferay.portal.kernel.exception.SystemException;
393    
394            /**
395            * Returns the number of trash entries with the group ID.
396            *
397            * @param groupId the primary key of the group
398            * @return the number of matching trash entries
399            * @throws SystemException if a system exception occurred
400            */
401            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
402            public int getEntriesCount(long groupId)
403                    throws com.liferay.portal.kernel.exception.SystemException;
404    
405            /**
406            * Returns the trash entry with the primary key.
407            *
408            * @param entryId the primary key of the trash entry
409            * @return the trash entry with the primary key
410            * @throws PortalException if a trash entry with the primary key could not
411            be found
412            * @throws SystemException if a system exception occurred
413            */
414            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
415            public com.liferay.portlet.trash.model.TrashEntry getEntry(long entryId)
416                    throws com.liferay.portal.kernel.exception.PortalException,
417                            com.liferay.portal.kernel.exception.SystemException;
418    
419            /**
420            * Returns the entry with the entity class name and primary key.
421            *
422            * @param className the class name of the entity
423            * @param classPK the primary key of the entity
424            * @return the trash entry with the entity class name and primary key
425            * @throws PortalException if a trash entry with the primary key could not
426            be found
427            * @throws SystemException if a system exception occurred
428            */
429            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
430            public com.liferay.portlet.trash.model.TrashEntry getEntry(
431                    java.lang.String className, long classPK)
432                    throws com.liferay.portal.kernel.exception.PortalException,
433                            com.liferay.portal.kernel.exception.SystemException;
434    
435            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
436            public com.liferay.portal.kernel.search.Hits search(long companyId,
437                    long groupId, long userId, java.lang.String keywords, int start,
438                    int end, com.liferay.portal.kernel.search.Sort sort)
439                    throws com.liferay.portal.kernel.exception.SystemException;
440    }