001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portlet.imagegallery.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * 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.
023     *
024     * <p>
025     * 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.
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see IGFolderLocalService
030     * @see com.liferay.portlet.imagegallery.service.base.IGFolderLocalServiceBaseImpl
031     * @see com.liferay.portlet.imagegallery.service.impl.IGFolderLocalServiceImpl
032     * @generated
033     */
034    public class IGFolderLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * 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.
039             */
040    
041            /**
042            * Adds the i g folder to the database. Also notifies the appropriate model listeners.
043            *
044            * @param igFolder the i g folder
045            * @return the i g folder that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.imagegallery.model.IGFolder addIGFolder(
049                    com.liferay.portlet.imagegallery.model.IGFolder igFolder)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addIGFolder(igFolder);
052            }
053    
054            /**
055            * Creates a new i g folder with the primary key. Does not add the i g folder to the database.
056            *
057            * @param folderId the primary key for the new i g folder
058            * @return the new i g folder
059            */
060            public static com.liferay.portlet.imagegallery.model.IGFolder createIGFolder(
061                    long folderId) {
062                    return getService().createIGFolder(folderId);
063            }
064    
065            /**
066            * Deletes the i g folder with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param folderId the primary key of the i g folder
069            * @throws PortalException if a i g folder with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteIGFolder(long folderId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteIGFolder(folderId);
076            }
077    
078            /**
079            * Deletes the i g folder from the database. Also notifies the appropriate model listeners.
080            *
081            * @param igFolder the i g folder
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteIGFolder(
085                    com.liferay.portlet.imagegallery.model.IGFolder igFolder)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteIGFolder(igFolder);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * 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.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * 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.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            /**
162            * Returns the i g folder with the primary key.
163            *
164            * @param folderId the primary key of the i g folder
165            * @return the i g folder
166            * @throws PortalException if a i g folder with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portlet.imagegallery.model.IGFolder getIGFolder(
170                    long folderId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getIGFolder(folderId);
174            }
175    
176            public static com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return getService().getPersistedModel(primaryKeyObj);
181            }
182    
183            /**
184            * Returns the i g folder with the UUID in the group.
185            *
186            * @param uuid the UUID of i g folder
187            * @param groupId the group id of the i g folder
188            * @return the i g folder
189            * @throws PortalException if a i g folder with the UUID in the group could not be found
190            * @throws SystemException if a system exception occurred
191            */
192            public static com.liferay.portlet.imagegallery.model.IGFolder getIGFolderByUuidAndGroupId(
193                    java.lang.String uuid, long groupId)
194                    throws com.liferay.portal.kernel.exception.PortalException,
195                            com.liferay.portal.kernel.exception.SystemException {
196                    return getService().getIGFolderByUuidAndGroupId(uuid, groupId);
197            }
198    
199            /**
200            * Returns a range of all the i g folders.
201            *
202            * <p>
203            * 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.
204            * </p>
205            *
206            * @param start the lower bound of the range of i g folders
207            * @param end the upper bound of the range of i g folders (not inclusive)
208            * @return the range of i g folders
209            * @throws SystemException if a system exception occurred
210            */
211            public static java.util.List<com.liferay.portlet.imagegallery.model.IGFolder> getIGFolders(
212                    int start, int end)
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getIGFolders(start, end);
215            }
216    
217            /**
218            * Returns the number of i g folders.
219            *
220            * @return the number of i g folders
221            * @throws SystemException if a system exception occurred
222            */
223            public static int getIGFoldersCount()
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().getIGFoldersCount();
226            }
227    
228            /**
229            * Updates the i g folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
230            *
231            * @param igFolder the i g folder
232            * @return the i g folder that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public static com.liferay.portlet.imagegallery.model.IGFolder updateIGFolder(
236                    com.liferay.portlet.imagegallery.model.IGFolder igFolder)
237                    throws com.liferay.portal.kernel.exception.SystemException {
238                    return getService().updateIGFolder(igFolder);
239            }
240    
241            /**
242            * Updates the i g folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
243            *
244            * @param igFolder the i g folder
245            * @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.
246            * @return the i g folder that was updated
247            * @throws SystemException if a system exception occurred
248            */
249            public static com.liferay.portlet.imagegallery.model.IGFolder updateIGFolder(
250                    com.liferay.portlet.imagegallery.model.IGFolder igFolder, boolean merge)
251                    throws com.liferay.portal.kernel.exception.SystemException {
252                    return getService().updateIGFolder(igFolder, merge);
253            }
254    
255            /**
256            * Returns the Spring bean ID for this bean.
257            *
258            * @return the Spring bean ID for this bean
259            */
260            public static java.lang.String getBeanIdentifier() {
261                    return getService().getBeanIdentifier();
262            }
263    
264            /**
265            * Sets the Spring bean ID for this bean.
266            *
267            * @param beanIdentifier the Spring bean ID for this bean
268            */
269            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
270                    getService().setBeanIdentifier(beanIdentifier);
271            }
272    
273            public static com.liferay.portlet.imagegallery.model.IGFolder addFolder(
274                    long userId, long parentFolderId, java.lang.String name,
275                    java.lang.String description,
276                    com.liferay.portal.service.ServiceContext serviceContext)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException {
279                    return getService()
280                                       .addFolder(userId, parentFolderId, name, description,
281                            serviceContext);
282            }
283    
284            public static void addFolderResources(
285                    com.liferay.portlet.imagegallery.model.IGFolder folder,
286                    boolean addCommunityPermissions, boolean addGuestPermissions)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException {
289                    getService()
290                            .addFolderResources(folder, addCommunityPermissions,
291                            addGuestPermissions);
292            }
293    
294            public static void addFolderResources(
295                    com.liferay.portlet.imagegallery.model.IGFolder folder,
296                    java.lang.String[] communityPermissions,
297                    java.lang.String[] guestPermissions)
298                    throws com.liferay.portal.kernel.exception.PortalException,
299                            com.liferay.portal.kernel.exception.SystemException {
300                    getService()
301                            .addFolderResources(folder, communityPermissions, guestPermissions);
302            }
303    
304            public static void addFolderResources(long folderId,
305                    boolean addCommunityPermissions, boolean addGuestPermissions)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException {
308                    getService()
309                            .addFolderResources(folderId, addCommunityPermissions,
310                            addGuestPermissions);
311            }
312    
313            public static void addFolderResources(long folderId,
314                    java.lang.String[] communityPermissions,
315                    java.lang.String[] guestPermissions)
316                    throws com.liferay.portal.kernel.exception.PortalException,
317                            com.liferay.portal.kernel.exception.SystemException {
318                    getService()
319                            .addFolderResources(folderId, communityPermissions, guestPermissions);
320            }
321    
322            public static void deleteFolder(
323                    com.liferay.portlet.imagegallery.model.IGFolder folder)
324                    throws com.liferay.portal.kernel.exception.PortalException,
325                            com.liferay.portal.kernel.exception.SystemException {
326                    getService().deleteFolder(folder);
327            }
328    
329            public static void deleteFolder(long folderId)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException {
332                    getService().deleteFolder(folderId);
333            }
334    
335            public static void deleteFolders(long groupId)
336                    throws com.liferay.portal.kernel.exception.PortalException,
337                            com.liferay.portal.kernel.exception.SystemException {
338                    getService().deleteFolders(groupId);
339            }
340    
341            public static java.util.List<com.liferay.portlet.imagegallery.model.IGFolder> getCompanyFolders(
342                    long companyId, int start, int end)
343                    throws com.liferay.portal.kernel.exception.SystemException {
344                    return getService().getCompanyFolders(companyId, start, end);
345            }
346    
347            public static int getCompanyFoldersCount(long companyId)
348                    throws com.liferay.portal.kernel.exception.SystemException {
349                    return getService().getCompanyFoldersCount(companyId);
350            }
351    
352            public static com.liferay.portlet.imagegallery.model.IGFolder getFolder(
353                    long folderId)
354                    throws com.liferay.portal.kernel.exception.PortalException,
355                            com.liferay.portal.kernel.exception.SystemException {
356                    return getService().getFolder(folderId);
357            }
358    
359            public static com.liferay.portlet.imagegallery.model.IGFolder getFolder(
360                    long groupId, long parentFolderId, java.lang.String name)
361                    throws com.liferay.portal.kernel.exception.PortalException,
362                            com.liferay.portal.kernel.exception.SystemException {
363                    return getService().getFolder(groupId, parentFolderId, name);
364            }
365    
366            public static java.util.List<com.liferay.portlet.imagegallery.model.IGFolder> getFolders(
367                    long groupId)
368                    throws com.liferay.portal.kernel.exception.SystemException {
369                    return getService().getFolders(groupId);
370            }
371    
372            public static java.util.List<com.liferay.portlet.imagegallery.model.IGFolder> getFolders(
373                    long groupId, long parentFolderId)
374                    throws com.liferay.portal.kernel.exception.SystemException {
375                    return getService().getFolders(groupId, parentFolderId);
376            }
377    
378            public static java.util.List<com.liferay.portlet.imagegallery.model.IGFolder> getFolders(
379                    long groupId, long parentFolderId, int start, int end)
380                    throws com.liferay.portal.kernel.exception.SystemException {
381                    return getService().getFolders(groupId, parentFolderId, start, end);
382            }
383    
384            public static int getFoldersCount(long groupId, long parentFolderId)
385                    throws com.liferay.portal.kernel.exception.SystemException {
386                    return getService().getFoldersCount(groupId, parentFolderId);
387            }
388    
389            public static void getSubfolderIds(
390                    java.util.List<java.lang.Long> folderIds, long groupId, long folderId)
391                    throws com.liferay.portal.kernel.exception.SystemException {
392                    getService().getSubfolderIds(folderIds, groupId, folderId);
393            }
394    
395            public static com.liferay.portlet.imagegallery.model.IGFolder updateFolder(
396                    long folderId, long parentFolderId, java.lang.String name,
397                    java.lang.String description, boolean mergeWithParentFolder,
398                    com.liferay.portal.service.ServiceContext serviceContext)
399                    throws com.liferay.portal.kernel.exception.PortalException,
400                            com.liferay.portal.kernel.exception.SystemException {
401                    return getService()
402                                       .updateFolder(folderId, parentFolderId, name, description,
403                            mergeWithParentFolder, serviceContext);
404            }
405    
406            public static IGFolderLocalService getService() {
407                    if (_service == null) {
408                            _service = (IGFolderLocalService)PortalBeanLocatorUtil.locate(IGFolderLocalService.class.getName());
409    
410                            ReferenceRegistry.registerReference(IGFolderLocalServiceUtil.class,
411                                    "_service");
412                            MethodCache.remove(IGFolderLocalService.class);
413                    }
414    
415                    return _service;
416            }
417    
418            public void setService(IGFolderLocalService service) {
419                    MethodCache.remove(IGFolderLocalService.class);
420    
421                    _service = service;
422    
423                    ReferenceRegistry.registerReference(IGFolderLocalServiceUtil.class,
424                            "_service");
425                    MethodCache.remove(IGFolderLocalService.class);
426            }
427    
428            private static IGFolderLocalService _service;
429    }