001    /**
002     * Copyright (c) 2000-2012 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.journal.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.ReferenceRegistry;
019    
020    /**
021     * The utility for the journal folder local service. This utility wraps {@link com.liferay.portlet.journal.service.impl.JournalFolderLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
022     *
023     * <p>
024     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
025     * </p>
026     *
027     * @author Brian Wing Shun Chan
028     * @see JournalFolderLocalService
029     * @see com.liferay.portlet.journal.service.base.JournalFolderLocalServiceBaseImpl
030     * @see com.liferay.portlet.journal.service.impl.JournalFolderLocalServiceImpl
031     * @generated
032     */
033    public class JournalFolderLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalFolderLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the journal folder to the database. Also notifies the appropriate model listeners.
042            *
043            * @param journalFolder the journal folder
044            * @return the journal folder that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.journal.model.JournalFolder addJournalFolder(
048                    com.liferay.portlet.journal.model.JournalFolder journalFolder)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addJournalFolder(journalFolder);
051            }
052    
053            /**
054            * Creates a new journal folder with the primary key. Does not add the journal folder to the database.
055            *
056            * @param folderId the primary key for the new journal folder
057            * @return the new journal folder
058            */
059            public static com.liferay.portlet.journal.model.JournalFolder createJournalFolder(
060                    long folderId) {
061                    return getService().createJournalFolder(folderId);
062            }
063    
064            /**
065            * Deletes the journal folder with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param folderId the primary key of the journal folder
068            * @return the journal folder that was removed
069            * @throws PortalException if a journal folder with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portlet.journal.model.JournalFolder deleteJournalFolder(
073                    long folderId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteJournalFolder(folderId);
077            }
078    
079            /**
080            * Deletes the journal folder from the database. Also notifies the appropriate model listeners.
081            *
082            * @param journalFolder the journal folder
083            * @return the journal folder that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.journal.model.JournalFolder deleteJournalFolder(
087                    com.liferay.portlet.journal.model.JournalFolder journalFolder)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteJournalFolder(journalFolder);
090            }
091    
092            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
093                    return getService().dynamicQuery();
094            }
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 static java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException {
107                    return getService().dynamicQuery(dynamicQuery);
108            }
109    
110            /**
111            * Performs a dynamic query on the database and returns a range of the matching rows.
112            *
113            * <p>
114            * 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.journal.model.impl.JournalFolderModelImpl}. 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.
115            * </p>
116            *
117            * @param dynamicQuery the dynamic query
118            * @param start the lower bound of the range of model instances
119            * @param end the upper bound of the range of model instances (not inclusive)
120            * @return the range of matching rows
121            * @throws SystemException if a system exception occurred
122            */
123            @SuppressWarnings("rawtypes")
124            public static java.util.List dynamicQuery(
125                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
126                    int end) throws com.liferay.portal.kernel.exception.SystemException {
127                    return getService().dynamicQuery(dynamicQuery, start, end);
128            }
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.journal.model.impl.JournalFolderModelImpl}. 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 static 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                    return getService()
151                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
152            }
153    
154            /**
155            * Returns the number of rows that match the dynamic query.
156            *
157            * @param dynamicQuery the dynamic query
158            * @return the number of rows that match the dynamic query
159            * @throws SystemException if a system exception occurred
160            */
161            public static long dynamicQueryCount(
162                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().dynamicQueryCount(dynamicQuery);
165            }
166    
167            public static com.liferay.portlet.journal.model.JournalFolder fetchJournalFolder(
168                    long folderId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchJournalFolder(folderId);
171            }
172    
173            /**
174            * Returns the journal folder with the primary key.
175            *
176            * @param folderId the primary key of the journal folder
177            * @return the journal folder
178            * @throws PortalException if a journal folder with the primary key could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.journal.model.JournalFolder getJournalFolder(
182                    long folderId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getJournalFolder(folderId);
186            }
187    
188            public static com.liferay.portal.model.PersistedModel getPersistedModel(
189                    java.io.Serializable primaryKeyObj)
190                    throws com.liferay.portal.kernel.exception.PortalException,
191                            com.liferay.portal.kernel.exception.SystemException {
192                    return getService().getPersistedModel(primaryKeyObj);
193            }
194    
195            /**
196            * Returns the journal folder with the UUID in the group.
197            *
198            * @param uuid the UUID of journal folder
199            * @param groupId the group id of the journal folder
200            * @return the journal folder
201            * @throws PortalException if a journal folder with the UUID in the group could not be found
202            * @throws SystemException if a system exception occurred
203            */
204            public static com.liferay.portlet.journal.model.JournalFolder getJournalFolderByUuidAndGroupId(
205                    java.lang.String uuid, long groupId)
206                    throws com.liferay.portal.kernel.exception.PortalException,
207                            com.liferay.portal.kernel.exception.SystemException {
208                    return getService().getJournalFolderByUuidAndGroupId(uuid, groupId);
209            }
210    
211            /**
212            * Returns a range of all the journal folders.
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.journal.model.impl.JournalFolderModelImpl}. 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 journal folders
219            * @param end the upper bound of the range of journal folders (not inclusive)
220            * @return the range of journal folders
221            * @throws SystemException if a system exception occurred
222            */
223            public static java.util.List<com.liferay.portlet.journal.model.JournalFolder> getJournalFolders(
224                    int start, int end)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().getJournalFolders(start, end);
227            }
228    
229            /**
230            * Returns the number of journal folders.
231            *
232            * @return the number of journal folders
233            * @throws SystemException if a system exception occurred
234            */
235            public static int getJournalFoldersCount()
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().getJournalFoldersCount();
238            }
239    
240            /**
241            * Updates the journal folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
242            *
243            * @param journalFolder the journal folder
244            * @return the journal folder that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portlet.journal.model.JournalFolder updateJournalFolder(
248                    com.liferay.portlet.journal.model.JournalFolder journalFolder)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updateJournalFolder(journalFolder);
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            public static com.liferay.portlet.journal.model.JournalFolder addFolder(
272                    long userId, long groupId, long parentFolderId, java.lang.String name,
273                    java.lang.String description,
274                    com.liferay.portal.service.ServiceContext serviceContext)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException {
277                    return getService()
278                                       .addFolder(userId, groupId, parentFolderId, name,
279                            description, serviceContext);
280            }
281    
282            public static void deleteFolder(
283                    com.liferay.portlet.journal.model.JournalFolder folder)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException {
286                    getService().deleteFolder(folder);
287            }
288    
289            public static void deleteFolder(long folderId)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    getService().deleteFolder(folderId);
293            }
294    
295            public static void deleteFolders(long groupId)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException {
298                    getService().deleteFolders(groupId);
299            }
300    
301            public static com.liferay.portlet.journal.model.JournalFolder fetchFolder(
302                    long groupId, java.lang.String name)
303                    throws com.liferay.portal.kernel.exception.SystemException {
304                    return getService().fetchFolder(groupId, name);
305            }
306    
307            public static java.util.List<com.liferay.portlet.journal.model.JournalFolder> getCompanyFolders(
308                    long companyId, int start, int end)
309                    throws com.liferay.portal.kernel.exception.SystemException {
310                    return getService().getCompanyFolders(companyId, start, end);
311            }
312    
313            public static int getCompanyFoldersCount(long companyId)
314                    throws com.liferay.portal.kernel.exception.SystemException {
315                    return getService().getCompanyFoldersCount(companyId);
316            }
317    
318            public static com.liferay.portlet.journal.model.JournalFolder getFolder(
319                    long folderId)
320                    throws com.liferay.portal.kernel.exception.PortalException,
321                            com.liferay.portal.kernel.exception.SystemException {
322                    return getService().getFolder(folderId);
323            }
324    
325            public static java.util.List<com.liferay.portlet.journal.model.JournalFolder> getFolders(
326                    long groupId)
327                    throws com.liferay.portal.kernel.exception.SystemException {
328                    return getService().getFolders(groupId);
329            }
330    
331            public static java.util.List<com.liferay.portlet.journal.model.JournalFolder> getFolders(
332                    long groupId, long parentFolderId)
333                    throws com.liferay.portal.kernel.exception.SystemException {
334                    return getService().getFolders(groupId, parentFolderId);
335            }
336    
337            public static java.util.List<com.liferay.portlet.journal.model.JournalFolder> getFolders(
338                    long groupId, long parentFolderId, int start, int end)
339                    throws com.liferay.portal.kernel.exception.SystemException {
340                    return getService().getFolders(groupId, parentFolderId, start, end);
341            }
342    
343            public static java.util.List<java.lang.Object> getFoldersAndArticles(
344                    long groupId, long folderId, int start, int end,
345                    com.liferay.portal.kernel.util.OrderByComparator obc)
346                    throws com.liferay.portal.kernel.exception.SystemException {
347                    return getService()
348                                       .getFoldersAndArticles(groupId, folderId, start, end, obc);
349            }
350    
351            public static int getFoldersAndArticlesCount(long groupId,
352                    java.util.List<java.lang.Long> folderIds, int status)
353                    throws com.liferay.portal.kernel.exception.SystemException {
354                    return getService()
355                                       .getFoldersAndArticlesCount(groupId, folderIds, status);
356            }
357    
358            public static int getFoldersAndArticlesCount(long groupId, long folderId)
359                    throws com.liferay.portal.kernel.exception.SystemException {
360                    return getService().getFoldersAndArticlesCount(groupId, folderId);
361            }
362    
363            public static int getFoldersCount(long groupId, long parentFolderId)
364                    throws com.liferay.portal.kernel.exception.SystemException {
365                    return getService().getFoldersCount(groupId, parentFolderId);
366            }
367    
368            public static void getSubfolderIds(
369                    java.util.List<java.lang.Long> folderIds, long groupId, long folderId)
370                    throws com.liferay.portal.kernel.exception.SystemException {
371                    getService().getSubfolderIds(folderIds, groupId, folderId);
372            }
373    
374            public static com.liferay.portlet.journal.model.JournalFolder moveFolder(
375                    long folderId, long parentFolderId,
376                    com.liferay.portal.service.ServiceContext serviceContext)
377                    throws com.liferay.portal.kernel.exception.PortalException,
378                            com.liferay.portal.kernel.exception.SystemException {
379                    return getService().moveFolder(folderId, parentFolderId, serviceContext);
380            }
381    
382            public static com.liferay.portlet.journal.model.JournalFolder updateFolder(
383                    long folderId, long parentFolderId, java.lang.String name,
384                    java.lang.String description, boolean mergeWithParentFolder,
385                    com.liferay.portal.service.ServiceContext serviceContext)
386                    throws com.liferay.portal.kernel.exception.PortalException,
387                            com.liferay.portal.kernel.exception.SystemException {
388                    return getService()
389                                       .updateFolder(folderId, parentFolderId, name, description,
390                            mergeWithParentFolder, serviceContext);
391            }
392    
393            public static JournalFolderLocalService getService() {
394                    if (_service == null) {
395                            _service = (JournalFolderLocalService)PortalBeanLocatorUtil.locate(JournalFolderLocalService.class.getName());
396    
397                            ReferenceRegistry.registerReference(JournalFolderLocalServiceUtil.class,
398                                    "_service");
399                    }
400    
401                    return _service;
402            }
403    
404            /**
405             * @deprecated
406             */
407            public void setService(JournalFolderLocalService service) {
408            }
409    
410            private static JournalFolderLocalService _service;
411    }