001    /**
002     * Copyright (c) 2000-2010 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.imagegallery.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    
019    /**
020     * The utility for the i g folder local service. This utility wraps {@link com.liferay.portlet.imagegallery.service.impl.IGFolderLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
021     *
022     * <p>
023     * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.imagegallery.service.impl.IGFolderLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
024     * </p>
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see IGFolderLocalService
032     * @see com.liferay.portlet.imagegallery.service.base.IGFolderLocalServiceBaseImpl
033     * @see com.liferay.portlet.imagegallery.service.impl.IGFolderLocalServiceImpl
034     * @generated
035     */
036    public class IGFolderLocalServiceUtil {
037            /**
038            * Adds the i g folder to the database. Also notifies the appropriate model listeners.
039            *
040            * @param igFolder the i g folder to add
041            * @return the i g folder that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portlet.imagegallery.model.IGFolder addIGFolder(
045                    com.liferay.portlet.imagegallery.model.IGFolder igFolder)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addIGFolder(igFolder);
048            }
049    
050            /**
051            * Creates a new i g folder with the primary key. Does not add the i g folder to the database.
052            *
053            * @param folderId the primary key for the new i g folder
054            * @return the new i g folder
055            */
056            public static com.liferay.portlet.imagegallery.model.IGFolder createIGFolder(
057                    long folderId) {
058                    return getService().createIGFolder(folderId);
059            }
060    
061            /**
062            * Deletes the i g folder with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param folderId the primary key of the i g folder to delete
065            * @throws PortalException if a i g folder with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteIGFolder(long folderId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteIGFolder(folderId);
072            }
073    
074            /**
075            * Deletes the i g folder from the database. Also notifies the appropriate model listeners.
076            *
077            * @param igFolder the i g folder to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteIGFolder(
081                    com.liferay.portlet.imagegallery.model.IGFolder igFolder)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteIGFolder(igFolder);
084            }
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query to search with
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public static java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException {
097                    return getService().dynamicQuery(dynamicQuery);
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * 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.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query to search with
108            * @param start the lower bound of the range of model instances to return
109            * @param end the upper bound of the range of model instances to return (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public static java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException {
117                    return getService().dynamicQuery(dynamicQuery, start, end);
118            }
119    
120            /**
121            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
122            *
123            * <p>
124            * 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.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query to search with
128            * @param start the lower bound of the range of model instances to return
129            * @param end the upper bound of the range of model instances to return (not inclusive)
130            * @param orderByComparator the comparator to order the results by
131            * @return the ordered range of matching rows
132            * @throws SystemException if a system exception occurred
133            */
134            @SuppressWarnings("rawtypes")
135            public static java.util.List dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
137                    int end,
138                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
139                    throws com.liferay.portal.kernel.exception.SystemException {
140                    return getService()
141                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
142            }
143    
144            /**
145            * Counts the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query to search with
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public static long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().dynamicQueryCount(dynamicQuery);
155            }
156    
157            /**
158            * Gets the i g folder with the primary key.
159            *
160            * @param folderId the primary key of the i g folder to get
161            * @return the i g folder
162            * @throws PortalException if a i g folder with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portlet.imagegallery.model.IGFolder getIGFolder(
166                    long folderId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getIGFolder(folderId);
170            }
171    
172            /**
173            * Gets the i g folder with the UUID and group id.
174            *
175            * @param uuid the UUID of i g folder to get
176            * @param groupId the group id of the i g folder to get
177            * @return the i g folder
178            * @throws PortalException if a i g folder with the UUID and group id could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.imagegallery.model.IGFolder getIGFolderByUuidAndGroupId(
182                    java.lang.String uuid, long groupId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getIGFolderByUuidAndGroupId(uuid, groupId);
186            }
187    
188            /**
189            * Gets a range of all the i g folders.
190            *
191            * <p>
192            * 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.
193            * </p>
194            *
195            * @param start the lower bound of the range of i g folders to return
196            * @param end the upper bound of the range of i g folders to return (not inclusive)
197            * @return the range of i g folders
198            * @throws SystemException if a system exception occurred
199            */
200            public static java.util.List<com.liferay.portlet.imagegallery.model.IGFolder> getIGFolders(
201                    int start, int end)
202                    throws com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getIGFolders(start, end);
204            }
205    
206            /**
207            * Gets the number of i g folders.
208            *
209            * @return the number of i g folders
210            * @throws SystemException if a system exception occurred
211            */
212            public static int getIGFoldersCount()
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getIGFoldersCount();
215            }
216    
217            /**
218            * Updates the i g folder in the database. Also notifies the appropriate model listeners.
219            *
220            * @param igFolder the i g folder to update
221            * @return the i g folder that was updated
222            * @throws SystemException if a system exception occurred
223            */
224            public static com.liferay.portlet.imagegallery.model.IGFolder updateIGFolder(
225                    com.liferay.portlet.imagegallery.model.IGFolder igFolder)
226                    throws com.liferay.portal.kernel.exception.SystemException {
227                    return getService().updateIGFolder(igFolder);
228            }
229    
230            /**
231            * Updates the i g folder in the database. Also notifies the appropriate model listeners.
232            *
233            * @param igFolder the i g folder to update
234            * @param merge whether to merge the i g folder with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
235            * @return the i g folder that was updated
236            * @throws SystemException if a system exception occurred
237            */
238            public static com.liferay.portlet.imagegallery.model.IGFolder updateIGFolder(
239                    com.liferay.portlet.imagegallery.model.IGFolder igFolder, boolean merge)
240                    throws com.liferay.portal.kernel.exception.SystemException {
241                    return getService().updateIGFolder(igFolder, merge);
242            }
243    
244            public static com.liferay.portlet.imagegallery.model.IGFolder addFolder(
245                    long userId, long parentFolderId, java.lang.String name,
246                    java.lang.String description,
247                    com.liferay.portal.service.ServiceContext serviceContext)
248                    throws com.liferay.portal.kernel.exception.PortalException,
249                            com.liferay.portal.kernel.exception.SystemException {
250                    return getService()
251                                       .addFolder(userId, parentFolderId, name, description,
252                            serviceContext);
253            }
254    
255            public static void addFolderResources(
256                    com.liferay.portlet.imagegallery.model.IGFolder folder,
257                    boolean addCommunityPermissions, boolean addGuestPermissions)
258                    throws com.liferay.portal.kernel.exception.PortalException,
259                            com.liferay.portal.kernel.exception.SystemException {
260                    getService()
261                            .addFolderResources(folder, addCommunityPermissions,
262                            addGuestPermissions);
263            }
264    
265            public static void addFolderResources(
266                    com.liferay.portlet.imagegallery.model.IGFolder folder,
267                    java.lang.String[] communityPermissions,
268                    java.lang.String[] guestPermissions)
269                    throws com.liferay.portal.kernel.exception.PortalException,
270                            com.liferay.portal.kernel.exception.SystemException {
271                    getService()
272                            .addFolderResources(folder, communityPermissions, guestPermissions);
273            }
274    
275            public static void addFolderResources(long folderId,
276                    boolean addCommunityPermissions, boolean addGuestPermissions)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException {
279                    getService()
280                            .addFolderResources(folderId, addCommunityPermissions,
281                            addGuestPermissions);
282            }
283    
284            public static void addFolderResources(long folderId,
285                    java.lang.String[] communityPermissions,
286                    java.lang.String[] guestPermissions)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException {
289                    getService()
290                            .addFolderResources(folderId, communityPermissions, guestPermissions);
291            }
292    
293            public static void deleteFolder(
294                    com.liferay.portlet.imagegallery.model.IGFolder folder)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException {
297                    getService().deleteFolder(folder);
298            }
299    
300            public static void deleteFolder(long folderId)
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException {
303                    getService().deleteFolder(folderId);
304            }
305    
306            public static void deleteFolders(long groupId)
307                    throws com.liferay.portal.kernel.exception.PortalException,
308                            com.liferay.portal.kernel.exception.SystemException {
309                    getService().deleteFolders(groupId);
310            }
311    
312            public static java.util.List<com.liferay.portlet.imagegallery.model.IGFolder> getCompanyFolders(
313                    long companyId, int start, int end)
314                    throws com.liferay.portal.kernel.exception.SystemException {
315                    return getService().getCompanyFolders(companyId, start, end);
316            }
317    
318            public static int getCompanyFoldersCount(long companyId)
319                    throws com.liferay.portal.kernel.exception.SystemException {
320                    return getService().getCompanyFoldersCount(companyId);
321            }
322    
323            public static com.liferay.portlet.imagegallery.model.IGFolder getFolder(
324                    long folderId)
325                    throws com.liferay.portal.kernel.exception.PortalException,
326                            com.liferay.portal.kernel.exception.SystemException {
327                    return getService().getFolder(folderId);
328            }
329    
330            public static com.liferay.portlet.imagegallery.model.IGFolder getFolder(
331                    long groupId, long parentFolderId, java.lang.String name)
332                    throws com.liferay.portal.kernel.exception.PortalException,
333                            com.liferay.portal.kernel.exception.SystemException {
334                    return getService().getFolder(groupId, parentFolderId, name);
335            }
336    
337            public static java.util.List<com.liferay.portlet.imagegallery.model.IGFolder> getFolders(
338                    long groupId)
339                    throws com.liferay.portal.kernel.exception.SystemException {
340                    return getService().getFolders(groupId);
341            }
342    
343            public static java.util.List<com.liferay.portlet.imagegallery.model.IGFolder> getFolders(
344                    long groupId, long parentFolderId)
345                    throws com.liferay.portal.kernel.exception.SystemException {
346                    return getService().getFolders(groupId, parentFolderId);
347            }
348    
349            public static java.util.List<com.liferay.portlet.imagegallery.model.IGFolder> getFolders(
350                    long groupId, long parentFolderId, int start, int end)
351                    throws com.liferay.portal.kernel.exception.SystemException {
352                    return getService().getFolders(groupId, parentFolderId, start, end);
353            }
354    
355            public static int getFoldersCount(long groupId, long parentFolderId)
356                    throws com.liferay.portal.kernel.exception.SystemException {
357                    return getService().getFoldersCount(groupId, parentFolderId);
358            }
359    
360            public static void getSubfolderIds(
361                    java.util.List<java.lang.Long> folderIds, long groupId, long folderId)
362                    throws com.liferay.portal.kernel.exception.SystemException {
363                    getService().getSubfolderIds(folderIds, groupId, folderId);
364            }
365    
366            public static com.liferay.portlet.imagegallery.model.IGFolder updateFolder(
367                    long folderId, long parentFolderId, java.lang.String name,
368                    java.lang.String description, boolean mergeWithParentFolder,
369                    com.liferay.portal.service.ServiceContext serviceContext)
370                    throws com.liferay.portal.kernel.exception.PortalException,
371                            com.liferay.portal.kernel.exception.SystemException {
372                    return getService()
373                                       .updateFolder(folderId, parentFolderId, name, description,
374                            mergeWithParentFolder, serviceContext);
375            }
376    
377            public static IGFolderLocalService getService() {
378                    if (_service == null) {
379                            _service = (IGFolderLocalService)PortalBeanLocatorUtil.locate(IGFolderLocalService.class.getName());
380                    }
381    
382                    return _service;
383            }
384    
385            public void setService(IGFolderLocalService service) {
386                    _service = service;
387            }
388    
389            private static IGFolderLocalService _service;
390    }