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.bean.PortalBeanLocatorUtil;
020    import com.liferay.portal.kernel.util.ReferenceRegistry;
021    
022    /**
023     * Provides the local service utility for TrashEntry. This utility wraps
024     * {@link com.liferay.portlet.trash.service.impl.TrashEntryLocalServiceImpl} and is the
025     * primary access point for service operations in application layer code running
026     * on the local server. Methods of this service will not have security checks
027     * based on the propagated JAAS credentials because this service can only be
028     * accessed from within the same VM.
029     *
030     * @author Brian Wing Shun Chan
031     * @see TrashEntryLocalService
032     * @see com.liferay.portlet.trash.service.base.TrashEntryLocalServiceBaseImpl
033     * @see com.liferay.portlet.trash.service.impl.TrashEntryLocalServiceImpl
034     * @generated
035     */
036    @ProviderType
037    public class TrashEntryLocalServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.trash.service.impl.TrashEntryLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
042             */
043    
044            /**
045            * Adds the trash entry to the database. Also notifies the appropriate model listeners.
046            *
047            * @param trashEntry the trash entry
048            * @return the trash entry that was added
049            * @throws SystemException if a system exception occurred
050            */
051            public static com.liferay.portlet.trash.model.TrashEntry addTrashEntry(
052                    com.liferay.portlet.trash.model.TrashEntry trashEntry)
053                    throws com.liferay.portal.kernel.exception.SystemException {
054                    return getService().addTrashEntry(trashEntry);
055            }
056    
057            /**
058            * Creates a new trash entry with the primary key. Does not add the trash entry to the database.
059            *
060            * @param entryId the primary key for the new trash entry
061            * @return the new trash entry
062            */
063            public static com.liferay.portlet.trash.model.TrashEntry createTrashEntry(
064                    long entryId) {
065                    return getService().createTrashEntry(entryId);
066            }
067    
068            /**
069            * Deletes the trash entry with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param entryId the primary key of the trash entry
072            * @return the trash entry that was removed
073            * @throws PortalException if a trash entry with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public static com.liferay.portlet.trash.model.TrashEntry deleteTrashEntry(
077                    long entryId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException {
080                    return getService().deleteTrashEntry(entryId);
081            }
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 static com.liferay.portlet.trash.model.TrashEntry deleteTrashEntry(
091                    com.liferay.portlet.trash.model.TrashEntry trashEntry)
092                    throws com.liferay.portal.kernel.exception.SystemException {
093                    return getService().deleteTrashEntry(trashEntry);
094            }
095    
096            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
097                    return getService().dynamicQuery();
098            }
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 static java.util.List dynamicQuery(
109                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
110                    throws com.liferay.portal.kernel.exception.SystemException {
111                    return getService().dynamicQuery(dynamicQuery);
112            }
113    
114            /**
115            * Performs a dynamic query on the database and returns a range of the matching rows.
116            *
117            * <p>
118            * 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query
122            * @param start the lower bound of the range of model instances
123            * @param end the upper bound of the range of model instances (not inclusive)
124            * @return the range of matching rows
125            * @throws SystemException if a system exception occurred
126            */
127            @SuppressWarnings("rawtypes")
128            public static java.util.List dynamicQuery(
129                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
130                    int end) throws com.liferay.portal.kernel.exception.SystemException {
131                    return getService().dynamicQuery(dynamicQuery, start, end);
132            }
133    
134            /**
135            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
136            *
137            * <p>
138            * 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.
139            * </p>
140            *
141            * @param dynamicQuery the dynamic query
142            * @param start the lower bound of the range of model instances
143            * @param end the upper bound of the range of model instances (not inclusive)
144            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
145            * @return the ordered range of matching rows
146            * @throws SystemException if a system exception occurred
147            */
148            @SuppressWarnings("rawtypes")
149            public static java.util.List dynamicQuery(
150                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
151                    int end,
152                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService()
155                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
156            }
157    
158            /**
159            * Returns the number of rows that match the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @return the number of rows that match the dynamic query
163            * @throws SystemException if a system exception occurred
164            */
165            public static long dynamicQueryCount(
166                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
167                    throws com.liferay.portal.kernel.exception.SystemException {
168                    return getService().dynamicQueryCount(dynamicQuery);
169            }
170    
171            /**
172            * Returns the number of rows that match the dynamic query.
173            *
174            * @param dynamicQuery the dynamic query
175            * @param projection the projection to apply to the query
176            * @return the number of rows that match the dynamic query
177            * @throws SystemException if a system exception occurred
178            */
179            public static long dynamicQueryCount(
180                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
181                    com.liferay.portal.kernel.dao.orm.Projection projection)
182                    throws com.liferay.portal.kernel.exception.SystemException {
183                    return getService().dynamicQueryCount(dynamicQuery, projection);
184            }
185    
186            public static com.liferay.portlet.trash.model.TrashEntry fetchTrashEntry(
187                    long entryId)
188                    throws com.liferay.portal.kernel.exception.SystemException {
189                    return getService().fetchTrashEntry(entryId);
190            }
191    
192            /**
193            * Returns the trash entry with the primary key.
194            *
195            * @param entryId the primary key of the trash entry
196            * @return the trash entry
197            * @throws PortalException if a trash entry with the primary key could not be found
198            * @throws SystemException if a system exception occurred
199            */
200            public static com.liferay.portlet.trash.model.TrashEntry getTrashEntry(
201                    long entryId)
202                    throws com.liferay.portal.kernel.exception.PortalException,
203                            com.liferay.portal.kernel.exception.SystemException {
204                    return getService().getTrashEntry(entryId);
205            }
206    
207            public static com.liferay.portal.model.PersistedModel getPersistedModel(
208                    java.io.Serializable primaryKeyObj)
209                    throws com.liferay.portal.kernel.exception.PortalException,
210                            com.liferay.portal.kernel.exception.SystemException {
211                    return getService().getPersistedModel(primaryKeyObj);
212            }
213    
214            /**
215            * Returns a range of all the trash entries.
216            *
217            * <p>
218            * 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.
219            * </p>
220            *
221            * @param start the lower bound of the range of trash entries
222            * @param end the upper bound of the range of trash entries (not inclusive)
223            * @return the range of trash entries
224            * @throws SystemException if a system exception occurred
225            */
226            public static java.util.List<com.liferay.portlet.trash.model.TrashEntry> getTrashEntries(
227                    int start, int end)
228                    throws com.liferay.portal.kernel.exception.SystemException {
229                    return getService().getTrashEntries(start, end);
230            }
231    
232            /**
233            * Returns the number of trash entries.
234            *
235            * @return the number of trash entries
236            * @throws SystemException if a system exception occurred
237            */
238            public static int getTrashEntriesCount()
239                    throws com.liferay.portal.kernel.exception.SystemException {
240                    return getService().getTrashEntriesCount();
241            }
242    
243            /**
244            * Updates the trash entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
245            *
246            * @param trashEntry the trash entry
247            * @return the trash entry that was updated
248            * @throws SystemException if a system exception occurred
249            */
250            public static com.liferay.portlet.trash.model.TrashEntry updateTrashEntry(
251                    com.liferay.portlet.trash.model.TrashEntry trashEntry)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    return getService().updateTrashEntry(trashEntry);
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            /**
275            * Moves an entry to trash.
276            *
277            * @param userId the primary key of the user removing the entity
278            * @param groupId the primary key of the entry's group
279            * @param className the class name of the entity
280            * @param classPK the primary key of the entity
281            * @param status the status of the entity prior to being moved to trash
282            * @param statusOVPs the primary keys and statuses of any of the entry's
283            versions (e.g., {@link
284            com.liferay.portlet.documentlibrary.model.DLFileVersion})
285            * @param typeSettingsProperties the type settings properties
286            * @return the trashEntry
287            * @throws PortalException if a user with the primary key could not be found
288            * @throws SystemException if a system exception occurred
289            */
290            public static com.liferay.portlet.trash.model.TrashEntry addTrashEntry(
291                    long userId, long groupId, java.lang.String className, long classPK,
292                    java.lang.String classUuid, java.lang.String referrerClassName,
293                    int status,
294                    java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.Long, java.lang.Integer>> statusOVPs,
295                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException {
298                    return getService()
299                                       .addTrashEntry(userId, groupId, className, classPK,
300                            classUuid, referrerClassName, status, statusOVPs,
301                            typeSettingsProperties);
302            }
303    
304            public static void checkEntries()
305                    throws com.liferay.portal.kernel.exception.PortalException,
306                            com.liferay.portal.kernel.exception.SystemException {
307                    getService().checkEntries();
308            }
309    
310            public static void deleteEntries(long groupId)
311                    throws com.liferay.portal.kernel.exception.SystemException {
312                    getService().deleteEntries(groupId);
313            }
314    
315            /**
316            * Deletes the trash entry with the primary key.
317            *
318            * @param entryId the primary key of the trash entry
319            * @return the trash entry with the primary key
320            * @throws PortalException if a trash entry with the primary key could not
321            be found
322            * @throws SystemException if a system exception occurred
323            */
324            public static com.liferay.portlet.trash.model.TrashEntry deleteEntry(
325                    long entryId)
326                    throws com.liferay.portal.kernel.exception.PortalException,
327                            com.liferay.portal.kernel.exception.SystemException {
328                    return getService().deleteEntry(entryId);
329            }
330    
331            /**
332            * Deletes the trash entry with the entity class name and primary key.
333            *
334            * @param className the class name of entity
335            * @param classPK the primary key of the entry
336            * @return the trash entry with the entity class name and primary key
337            * @throws PortalException if a trash entry with the primary key could not
338            be found
339            * @throws SystemException if a system exception occurred
340            */
341            public static com.liferay.portlet.trash.model.TrashEntry deleteEntry(
342                    java.lang.String className, long classPK)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException {
345                    return getService().deleteEntry(className, classPK);
346            }
347    
348            public static com.liferay.portlet.trash.model.TrashEntry deleteEntry(
349                    com.liferay.portlet.trash.model.TrashEntry trashEntry)
350                    throws com.liferay.portal.kernel.exception.SystemException {
351                    return getService().deleteEntry(trashEntry);
352            }
353    
354            /**
355            * Returns the trash entry with the primary key.
356            *
357            * @param entryId the primary key of the entry
358            * @return the trash entry with the primary key
359            * @throws SystemException if a system exception occurred
360            */
361            public static com.liferay.portlet.trash.model.TrashEntry fetchEntry(
362                    long entryId)
363                    throws com.liferay.portal.kernel.exception.SystemException {
364                    return getService().fetchEntry(entryId);
365            }
366    
367            /**
368            * Returns the trash entry with the entity class name and primary key.
369            *
370            * @param className the class name of the entity
371            * @param classPK the primary key of the entity
372            * @return the trash entry with the entity class name and primary key
373            * @throws SystemException if a system exception occurred
374            */
375            public static com.liferay.portlet.trash.model.TrashEntry fetchEntry(
376                    java.lang.String className, long classPK)
377                    throws com.liferay.portal.kernel.exception.SystemException {
378                    return getService().fetchEntry(className, classPK);
379            }
380    
381            /**
382            * Returns the trash entries with the matching group ID.
383            *
384            * @param groupId the primary key of the group
385            * @return the trash entries with the group ID
386            * @throws SystemException if a system exception occurred
387            */
388            public static java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries(
389                    long groupId)
390                    throws com.liferay.portal.kernel.exception.SystemException {
391                    return getService().getEntries(groupId);
392            }
393    
394            /**
395            * Returns a range of all the trash entries matching the group ID.
396            *
397            * @param groupId the primary key of the group
398            * @param start the lower bound of the range of trash entries to return
399            * @param end the upper bound of the range of trash entries to return (not
400            inclusive)
401            * @return the range of matching trash entries
402            * @throws SystemException if a system exception occurred
403            */
404            public static java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries(
405                    long groupId, int start, int end)
406                    throws com.liferay.portal.kernel.exception.SystemException {
407                    return getService().getEntries(groupId, start, end);
408            }
409    
410            /**
411            * Returns a range of all the trash entries matching the group ID.
412            *
413            * @param groupId the primary key of the group
414            * @param start the lower bound of the range of trash entries to return
415            * @param end the upper bound of the range of trash entries to return (not
416            inclusive)
417            * @param obc the comparator to order the trash entries (optionally
418            <code>null</code>)
419            * @return the range of matching trash entries ordered by comparator
420            <code>obc</code>
421            * @throws SystemException if a system exception occurred
422            */
423            public static java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries(
424                    long groupId, int start, int end,
425                    com.liferay.portal.kernel.util.OrderByComparator obc)
426                    throws com.liferay.portal.kernel.exception.SystemException {
427                    return getService().getEntries(groupId, start, end, obc);
428            }
429    
430            public static java.util.List<com.liferay.portlet.trash.model.TrashEntry> getEntries(
431                    long groupId, java.lang.String className)
432                    throws com.liferay.portal.kernel.exception.SystemException {
433                    return getService().getEntries(groupId, className);
434            }
435    
436            /**
437            * Returns the number of trash entries with the group ID.
438            *
439            * @param groupId the primary key of the group
440            * @return the number of matching trash entries
441            * @throws SystemException if a system exception occurred
442            */
443            public static int getEntriesCount(long groupId)
444                    throws com.liferay.portal.kernel.exception.SystemException {
445                    return getService().getEntriesCount(groupId);
446            }
447    
448            /**
449            * Returns the trash entry with the primary key.
450            *
451            * @param entryId the primary key of the trash entry
452            * @return the trash entry with the primary key
453            * @throws PortalException if a trash entry with the primary key could not
454            be found
455            * @throws SystemException if a system exception occurred
456            */
457            public static com.liferay.portlet.trash.model.TrashEntry getEntry(
458                    long entryId)
459                    throws com.liferay.portal.kernel.exception.PortalException,
460                            com.liferay.portal.kernel.exception.SystemException {
461                    return getService().getEntry(entryId);
462            }
463    
464            /**
465            * Returns the entry with the entity class name and primary key.
466            *
467            * @param className the class name of the entity
468            * @param classPK the primary key of the entity
469            * @return the trash entry with the entity class name and primary key
470            * @throws PortalException if a trash entry with the primary key could not
471            be found
472            * @throws SystemException if a system exception occurred
473            */
474            public static com.liferay.portlet.trash.model.TrashEntry getEntry(
475                    java.lang.String className, long classPK)
476                    throws com.liferay.portal.kernel.exception.PortalException,
477                            com.liferay.portal.kernel.exception.SystemException {
478                    return getService().getEntry(className, classPK);
479            }
480    
481            public static com.liferay.portal.kernel.search.Hits search(long companyId,
482                    long groupId, long userId, java.lang.String keywords, int start,
483                    int end, com.liferay.portal.kernel.search.Sort sort)
484                    throws com.liferay.portal.kernel.exception.SystemException {
485                    return getService()
486                                       .search(companyId, groupId, userId, keywords, start, end,
487                            sort);
488            }
489    
490            public static TrashEntryLocalService getService() {
491                    if (_service == null) {
492                            _service = (TrashEntryLocalService)PortalBeanLocatorUtil.locate(TrashEntryLocalService.class.getName());
493    
494                            ReferenceRegistry.registerReference(TrashEntryLocalServiceUtil.class,
495                                    "_service");
496                    }
497    
498                    return _service;
499            }
500    
501            /**
502             * @deprecated As of 6.2.0
503             */
504            public void setService(TrashEntryLocalService service) {
505            }
506    
507            private static TrashEntryLocalService _service;
508    }