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.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.PersistedModelLocalService;
026    
027    /**
028     * Provides the local service interface for TrashEntry. 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 TrashEntryLocalServiceUtil
035     * @see com.liferay.portlet.trash.service.base.TrashEntryLocalServiceBaseImpl
036     * @see com.liferay.portlet.trash.service.impl.TrashEntryLocalServiceImpl
037     * @generated
038     */
039    @ProviderType
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface TrashEntryLocalService extends BaseLocalService,
043            PersistedModelLocalService {
044            /*
045             * NOTE FOR DEVELOPERS:
046             *
047             * 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.
048             */
049    
050            /**
051            * Adds the trash entry to the database. Also notifies the appropriate model listeners.
052            *
053            * @param trashEntry the trash entry
054            * @return the trash entry that was added
055            * @throws SystemException if a system exception occurred
056            */
057            public com.liferay.portlet.trash.model.TrashEntry addTrashEntry(
058                    com.liferay.portlet.trash.model.TrashEntry trashEntry)
059                    throws com.liferay.portal.kernel.exception.SystemException;
060    
061            /**
062            * Creates a new trash entry with the primary key. Does not add the trash entry to the database.
063            *
064            * @param entryId the primary key for the new trash entry
065            * @return the new trash entry
066            */
067            public com.liferay.portlet.trash.model.TrashEntry createTrashEntry(
068                    long entryId);
069    
070            /**
071            * Deletes the trash entry with the primary key from the database. Also notifies the appropriate model listeners.
072            *
073            * @param entryId the primary key of the trash entry
074            * @return the trash entry that was removed
075            * @throws PortalException if a trash entry with the primary key could not be found
076            * @throws SystemException if a system exception occurred
077            */
078            public com.liferay.portlet.trash.model.TrashEntry deleteTrashEntry(
079                    long entryId)
080                    throws com.liferay.portal.kernel.exception.PortalException,
081                            com.liferay.portal.kernel.exception.SystemException;
082    
083            /**
084            * Deletes the trash entry from the database. Also notifies the appropriate model listeners.
085            *
086            * @param trashEntry the trash entry
087            * @return the trash entry that was removed
088            * @throws SystemException if a system exception occurred
089            */
090            public com.liferay.portlet.trash.model.TrashEntry deleteTrashEntry(
091                    com.liferay.portlet.trash.model.TrashEntry trashEntry)
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.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.
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.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.
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.trash.model.TrashEntry fetchTrashEntry(
173                    long entryId)
174                    throws com.liferay.portal.kernel.exception.SystemException;
175    
176            /**
177            * Returns the trash entry with the primary key.
178            *
179            * @param entryId the primary key of the trash entry
180            * @return the trash entry
181            * @throws PortalException if a trash entry with the primary key 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.trash.model.TrashEntry getTrashEntry(
186                    long entryId)
187                    throws com.liferay.portal.kernel.exception.PortalException,
188                            com.liferay.portal.kernel.exception.SystemException;
189    
190            @Override
191            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
192            public com.liferay.portal.model.PersistedModel getPersistedModel(
193                    java.io.Serializable primaryKeyObj)
194                    throws com.liferay.portal.kernel.exception.PortalException,
195                            com.liferay.portal.kernel.exception.SystemException;
196    
197            /**
198            * Returns a range of all the trash entries.
199            *
200            * <p>
201            * 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.
202            * </p>
203            *
204            * @param start the lower bound of the range of trash entries
205            * @param end the upper bound of the range of trash entries (not inclusive)
206            * @return the range of trash entries
207            * @throws SystemException if a system exception occurred
208            */
209            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
210            public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getTrashEntries(
211                    int start, int end)
212                    throws com.liferay.portal.kernel.exception.SystemException;
213    
214            /**
215            * Returns the number of trash entries.
216            *
217            * @return the number of trash entries
218            * @throws SystemException if a system exception occurred
219            */
220            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
221            public int getTrashEntriesCount()
222                    throws com.liferay.portal.kernel.exception.SystemException;
223    
224            /**
225            * Updates the trash entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
226            *
227            * @param trashEntry the trash entry
228            * @return the trash entry that was updated
229            * @throws SystemException if a system exception occurred
230            */
231            public com.liferay.portlet.trash.model.TrashEntry updateTrashEntry(
232                    com.liferay.portlet.trash.model.TrashEntry trashEntry)
233                    throws com.liferay.portal.kernel.exception.SystemException;
234    
235            /**
236            * Returns the Spring bean ID for this bean.
237            *
238            * @return the Spring bean ID for this bean
239            */
240            public java.lang.String getBeanIdentifier();
241    
242            /**
243            * Sets the Spring bean ID for this bean.
244            *
245            * @param beanIdentifier the Spring bean ID for this bean
246            */
247            public void setBeanIdentifier(java.lang.String beanIdentifier);
248    
249            /**
250            * Moves an entry to trash.
251            *
252            * @param userId the primary key of the user removing the entity
253            * @param groupId the primary key of the entry's group
254            * @param className the class name of the entity
255            * @param classPK the primary key of the entity
256            * @param status the status of the entity prior to being moved to trash
257            * @param statusOVPs the primary keys and statuses of any of the entry's
258            versions (e.g., {@link
259            com.liferay.portlet.documentlibrary.model.DLFileVersion})
260            * @param typeSettingsProperties the type settings properties
261            * @return the trashEntry
262            * @throws PortalException if a user with the primary key could not be found
263            * @throws SystemException if a system exception occurred
264            */
265            public com.liferay.portlet.trash.model.TrashEntry addTrashEntry(
266                    long userId, long groupId, java.lang.String className, long classPK,
267                    java.lang.String classUuid, java.lang.String referrerClassName,
268                    int status,
269                    java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.Long, java.lang.Integer>> statusOVPs,
270                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException;
273    
274            public void checkEntries()
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException;
277    
278            /**
279            * Deletes the trash entry with the primary key.
280            *
281            * @param entryId the primary key of the trash entry
282            * @return the trash entry with the primary key
283            * @throws PortalException if a trash entry with the primary key could not
284            be found
285            * @throws SystemException if a system exception occurred
286            */
287            public com.liferay.portlet.trash.model.TrashEntry deleteEntry(long entryId)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException;
290    
291            /**
292            * Deletes the trash entry with the entity class name and primary key.
293            *
294            * @param className the class name of entity
295            * @param classPK the primary key of the entry
296            * @return the trash entry with the entity class name and primary key
297            * @throws PortalException if a trash entry with the primary key could not
298            be found
299            * @throws SystemException if a system exception occurred
300            */
301            public com.liferay.portlet.trash.model.TrashEntry deleteEntry(
302                    java.lang.String className, long classPK)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException;
305    
306            public com.liferay.portlet.trash.model.TrashEntry deleteEntry(
307                    com.liferay.portlet.trash.model.TrashEntry trashEntry)
308                    throws com.liferay.portal.kernel.exception.SystemException;
309    
310            /**
311            * Returns the trash entry with the primary key.
312            *
313            * @param entryId the primary key of the entry
314            * @return the trash entry with the primary key
315            * @throws SystemException if a system exception occurred
316            */
317            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
318            public com.liferay.portlet.trash.model.TrashEntry fetchEntry(long entryId)
319                    throws com.liferay.portal.kernel.exception.SystemException;
320    
321            /**
322            * Returns the trash entry with the entity class name and primary key.
323            *
324            * @param className the class name of the entity
325            * @param classPK the primary key of the entity
326            * @return the trash entry with the entity class name and primary key
327            * @throws SystemException if a system exception occurred
328            */
329            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
330            public com.liferay.portlet.trash.model.TrashEntry fetchEntry(
331                    java.lang.String className, long classPK)
332                    throws com.liferay.portal.kernel.exception.SystemException;
333    
334            /**
335            * Returns the trash entries with the matching group ID.
336            *
337            * @param groupId the primary key of the group
338            * @return the trash entries with the group ID
339            * @throws SystemException if a system exception occurred
340            */
341            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
342            public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries(
343                    long groupId)
344                    throws com.liferay.portal.kernel.exception.SystemException;
345    
346            /**
347            * Returns a range of all the trash entries matching the group ID.
348            *
349            * @param groupId the primary key of the group
350            * @param start the lower bound of the range of trash entries to return
351            * @param end the upper bound of the range of trash entries to return (not
352            inclusive)
353            * @return the range of matching trash entries
354            * @throws SystemException if a system exception occurred
355            */
356            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
357            public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries(
358                    long groupId, int start, int end)
359                    throws com.liferay.portal.kernel.exception.SystemException;
360    
361            /**
362            * Returns a range of all the trash entries matching the group ID.
363            *
364            * @param groupId the primary key of the group
365            * @param start the lower bound of the range of trash entries to return
366            * @param end the upper bound of the range of trash entries to return (not
367            inclusive)
368            * @param obc the comparator to order the trash entries (optionally
369            <code>null</code>)
370            * @return the range of matching trash entries ordered by comparator
371            <code>obc</code>
372            * @throws SystemException if a system exception occurred
373            */
374            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
375            public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries(
376                    long groupId, int start, int end,
377                    com.liferay.portal.kernel.util.OrderByComparator obc)
378                    throws com.liferay.portal.kernel.exception.SystemException;
379    
380            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
381            public java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries(
382                    long groupId, java.lang.String className)
383                    throws com.liferay.portal.kernel.exception.SystemException;
384    
385            /**
386            * Returns the number of trash entries with the group ID.
387            *
388            * @param groupId the primary key of the group
389            * @return the number of matching trash entries
390            * @throws SystemException if a system exception occurred
391            */
392            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
393            public int getEntriesCount(long groupId)
394                    throws com.liferay.portal.kernel.exception.SystemException;
395    
396            /**
397            * Returns the trash entry with the primary key.
398            *
399            * @param entryId the primary key of the trash entry
400            * @return the trash entry with the primary key
401            * @throws PortalException if a trash entry with the primary key could not
402            be found
403            * @throws SystemException if a system exception occurred
404            */
405            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
406            public com.liferay.portlet.trash.model.TrashEntry getEntry(long entryId)
407                    throws com.liferay.portal.kernel.exception.PortalException,
408                            com.liferay.portal.kernel.exception.SystemException;
409    
410            /**
411            * Returns the entry with the entity class name and primary key.
412            *
413            * @param className the class name of the entity
414            * @param classPK the primary key of the entity
415            * @return the trash entry with the entity class name and primary key
416            * @throws PortalException if a trash entry with the primary key could not
417            be found
418            * @throws SystemException if a system exception occurred
419            */
420            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
421            public com.liferay.portlet.trash.model.TrashEntry getEntry(
422                    java.lang.String className, long classPK)
423                    throws com.liferay.portal.kernel.exception.PortalException,
424                            com.liferay.portal.kernel.exception.SystemException;
425    
426            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
427            public com.liferay.portal.kernel.search.Hits search(long companyId,
428                    long groupId, long userId, java.lang.String keywords, int start,
429                    int end, com.liferay.portal.kernel.search.Sort sort)
430                    throws com.liferay.portal.kernel.exception.SystemException;
431    }