1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portlet.documentlibrary.service;
24  
25  
26  /**
27   * <a href="DLFolderServiceUtil.java.html"><b><i>View Source</i></b></a>
28   *
29   * <p>
30   * ServiceBuilder generated this class. Modifications in this class will be
31   * overwritten the next time is generated.
32   * </p>
33   *
34   * <p>
35   * This class provides static methods for the
36   * <code>com.liferay.portlet.documentlibrary.service.DLFolderService</code>
37   * bean. The static methods of this class calls the same methods of the bean
38   * instance. It's convenient to be able to just write one line to call a method
39   * on a bean instead of writing a lookup call and a method call.
40   * </p>
41   *
42   * @author Brian Wing Shun Chan
43   *
44   * @see com.liferay.portlet.documentlibrary.service.DLFolderService
45   *
46   */
47  public class DLFolderServiceUtil {
48      public static com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
49          long groupId, long parentFolderId, java.lang.String name,
50          java.lang.String description, boolean addCommunityPermissions,
51          boolean addGuestPermissions)
52          throws com.liferay.portal.PortalException,
53              com.liferay.portal.SystemException {
54          return getService()
55                     .addFolder(groupId, parentFolderId, name, description,
56              addCommunityPermissions, addGuestPermissions);
57      }
58  
59      public static com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
60          long groupId, long parentFolderId, java.lang.String name,
61          java.lang.String description, java.lang.String[] communityPermissions,
62          java.lang.String[] guestPermissions)
63          throws com.liferay.portal.PortalException,
64              com.liferay.portal.SystemException {
65          return getService()
66                     .addFolder(groupId, parentFolderId, name, description,
67              communityPermissions, guestPermissions);
68      }
69  
70      public static com.liferay.portlet.documentlibrary.model.DLFolder copyFolder(
71          long groupId, long sourceFolderId, long parentFolderId,
72          java.lang.String name, java.lang.String description,
73          boolean addCommunityPermissions, boolean addGuestPermissions)
74          throws com.liferay.portal.PortalException,
75              com.liferay.portal.SystemException, java.rmi.RemoteException {
76          return getService()
77                     .copyFolder(groupId, sourceFolderId, parentFolderId, name,
78              description, addCommunityPermissions, addGuestPermissions);
79      }
80  
81      public static void deleteFolder(long folderId)
82          throws com.liferay.portal.PortalException,
83              com.liferay.portal.SystemException, java.rmi.RemoteException {
84          getService().deleteFolder(folderId);
85      }
86  
87      public static void deleteFolder(long groupId, long parentFolderId,
88          java.lang.String name)
89          throws com.liferay.portal.PortalException,
90              com.liferay.portal.SystemException, java.rmi.RemoteException {
91          getService().deleteFolder(groupId, parentFolderId, name);
92      }
93  
94      public static com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
95          long folderId)
96          throws com.liferay.portal.PortalException,
97              com.liferay.portal.SystemException {
98          return getService().getFolder(folderId);
99      }
100 
101     public static com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
102         long groupId, long parentFolderId, java.lang.String name)
103         throws com.liferay.portal.PortalException,
104             com.liferay.portal.SystemException {
105         return getService().getFolder(groupId, parentFolderId, name);
106     }
107 
108     public static long getFolderId(long groupId, long parentFolderId,
109         java.lang.String name)
110         throws com.liferay.portal.PortalException,
111             com.liferay.portal.SystemException {
112         return getService().getFolderId(groupId, parentFolderId, name);
113     }
114 
115     public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
116         long groupId, long parentFolderId)
117         throws com.liferay.portal.PortalException,
118             com.liferay.portal.SystemException {
119         return getService().getFolders(groupId, parentFolderId);
120     }
121 
122     public static boolean hasInheritableLock(long folderId)
123         throws com.liferay.portal.PortalException {
124         return getService().hasInheritableLock(folderId);
125     }
126 
127     public static com.liferay.lock.model.Lock lockFolder(long folderId)
128         throws com.liferay.portal.PortalException,
129             com.liferay.portal.SystemException, java.rmi.RemoteException {
130         return getService().lockFolder(folderId);
131     }
132 
133     public static com.liferay.lock.model.Lock lockFolder(long folderId,
134         java.lang.String owner, boolean inheritable, long expirationTime)
135         throws com.liferay.portal.PortalException,
136             com.liferay.portal.SystemException, java.rmi.RemoteException {
137         return getService()
138                    .lockFolder(folderId, owner, inheritable, expirationTime);
139     }
140 
141     public static com.liferay.lock.model.Lock refreshFolderLock(
142         java.lang.String lockUuid, long expirationTime)
143         throws com.liferay.portal.PortalException {
144         return getService().refreshFolderLock(lockUuid, expirationTime);
145     }
146 
147     public static void reIndexSearch(long companyId)
148         throws com.liferay.portal.PortalException,
149             com.liferay.portal.SystemException {
150         getService().reIndexSearch(companyId);
151     }
152 
153     public static void unlockFolder(long folderId, java.lang.String lockUuid)
154         throws com.liferay.portal.PortalException {
155         getService().unlockFolder(folderId, lockUuid);
156     }
157 
158     public static void unlockFolder(long groupId, long parentFolderId,
159         java.lang.String name, java.lang.String lockUuid)
160         throws com.liferay.portal.PortalException,
161             com.liferay.portal.SystemException {
162         getService().unlockFolder(groupId, parentFolderId, name, lockUuid);
163     }
164 
165     public static com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
166         long folderId, long parentFolderId, java.lang.String name,
167         java.lang.String description)
168         throws com.liferay.portal.PortalException,
169             com.liferay.portal.SystemException, java.rmi.RemoteException {
170         return getService()
171                    .updateFolder(folderId, parentFolderId, name, description);
172     }
173 
174     public static boolean verifyInheritableLock(long folderId,
175         java.lang.String lockUuid) throws com.liferay.portal.PortalException {
176         return getService().verifyInheritableLock(folderId, lockUuid);
177     }
178 
179     public static DLFolderService getService() {
180         if (_service == null) {
181             throw new RuntimeException("DLFolderService is not set");
182         }
183 
184         return _service;
185     }
186 
187     public void setService(DLFolderService service) {
188         _service = service;
189     }
190 
191     private static DLFolderService _service;
192 }