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