1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17   * SOFTWARE.
18   */
19  
20  package com.liferay.portlet.documentlibrary.service.http;
21  
22  import com.liferay.portal.kernel.json.JSONArray;
23  import com.liferay.portal.kernel.json.JSONObject;
24  
25  import com.liferay.portlet.documentlibrary.service.DLFolderServiceUtil;
26  
27  /**
28   * <a href="DLFolderServiceJSON.java.html"><b><i>View Source</i></b></a>
29   *
30   * <p>
31   * ServiceBuilder generated this class. Modifications in this class will be
32   * overwritten the next time is generated.
33   * </p>
34   *
35   * <p>
36   * This class provides a JSON utility for the
37   * <code>com.liferay.portlet.documentlibrary.service.DLFolderServiceUtil</code>
38   * service utility. The static methods of this class calls the same methods of
39   * the service utility. However, the signatures are different because it is
40   * difficult for JSON to support certain types.
41   * </p>
42   *
43   * <p>
44   * ServiceBuilder follows certain rules in translating the methods. For example,
45   * if the method in the service utility returns a <code>java.util.List</code>,
46   * that is translated to a
47   * <code>com.liferay.portal.kernel.json.JSONArray</code>. If the method in the
48   * service utility returns a <code>com.liferay.portlet.documentlibrary.model.DLFolder</code>,
49   * that is translated to a
50   * <code>com.liferay.portal.kernel.json.JSONObject</code>. Methods that JSON
51   * cannot safely use are skipped. The logic for the translation is encapsulated
52   * in <code>com.liferay.portlet.documentlibrary.service.http.DLFolderJSONSerializer</code>.
53   * </p>
54   *
55   * <p>
56   * This allows you to call the the backend services directly from JavaScript.
57   * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
58   * reference of how that portlet uses the generated JavaScript in
59   * <code>portal-web/docroot/html/js/service.js</code> to call the backend
60   * services directly from JavaScript.
61   * </p>
62   *
63   * <p>
64   * The JSON utility is only generated for remote services.
65   * </p>
66   *
67   * @author Brian Wing Shun Chan
68   *
69   * @see com.liferay.portlet.documentlibrary.service.DLFolderServiceUtil
70   * @see com.liferay.portlet.documentlibrary.service.http.DLFolderJSONSerializer
71   *
72   */
73  public class DLFolderServiceJSON {
74      public static JSONObject addFolder(long plid, long parentFolderId,
75          java.lang.String name, java.lang.String description,
76          boolean addCommunityPermissions, boolean addGuestPermissions)
77          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
78              com.liferay.portal.SystemException {
79          com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.addFolder(plid,
80                  parentFolderId, name, description, addCommunityPermissions,
81                  addGuestPermissions);
82  
83          return DLFolderJSONSerializer.toJSONObject(returnValue);
84      }
85  
86      public static JSONObject addFolder(long plid, long parentFolderId,
87          java.lang.String name, java.lang.String description,
88          java.lang.String[] communityPermissions,
89          java.lang.String[] guestPermissions)
90          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
91              com.liferay.portal.SystemException {
92          com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.addFolder(plid,
93                  parentFolderId, name, description, communityPermissions,
94                  guestPermissions);
95  
96          return DLFolderJSONSerializer.toJSONObject(returnValue);
97      }
98  
99      public static JSONObject copyFolder(long plid, long sourceFolderId,
100         long parentFolderId, java.lang.String name,
101         java.lang.String description, boolean addCommunityPermissions,
102         boolean addGuestPermissions)
103         throws com.liferay.portal.PortalException,
104             com.liferay.portal.SystemException, java.rmi.RemoteException {
105         com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.copyFolder(plid,
106                 sourceFolderId, parentFolderId, name, description,
107                 addCommunityPermissions, addGuestPermissions);
108 
109         return DLFolderJSONSerializer.toJSONObject(returnValue);
110     }
111 
112     public static void deleteFolder(long folderId)
113         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
114             com.liferay.portal.SystemException {
115         DLFolderServiceUtil.deleteFolder(folderId);
116     }
117 
118     public static void deleteFolder(long groupId, long parentFolderId,
119         java.lang.String name)
120         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
121             com.liferay.portal.SystemException {
122         DLFolderServiceUtil.deleteFolder(groupId, parentFolderId, name);
123     }
124 
125     public static JSONObject getFolder(long folderId)
126         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
127             com.liferay.portal.SystemException {
128         com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.getFolder(folderId);
129 
130         return DLFolderJSONSerializer.toJSONObject(returnValue);
131     }
132 
133     public static JSONObject getFolder(long groupId, long parentFolderId,
134         java.lang.String name)
135         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
136             com.liferay.portal.SystemException {
137         com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.getFolder(groupId,
138                 parentFolderId, name);
139 
140         return DLFolderJSONSerializer.toJSONObject(returnValue);
141     }
142 
143     public static long getFolderId(long groupId, long parentFolderId,
144         java.lang.String name)
145         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
146             com.liferay.portal.SystemException {
147         long returnValue = DLFolderServiceUtil.getFolderId(groupId,
148                 parentFolderId, name);
149 
150         return returnValue;
151     }
152 
153     public static JSONArray getFolders(long groupId, long parentFolderId)
154         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
155             com.liferay.portal.SystemException {
156         java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> returnValue =
157             DLFolderServiceUtil.getFolders(groupId, parentFolderId);
158 
159         return DLFolderJSONSerializer.toJSONArray(returnValue);
160     }
161 
162     public static void reIndexSearch(long companyId)
163         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
164             com.liferay.portal.SystemException {
165         DLFolderServiceUtil.reIndexSearch(companyId);
166     }
167 
168     public static JSONObject updateFolder(long folderId, long parentFolderId,
169         java.lang.String name, java.lang.String description)
170         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
171             com.liferay.portal.SystemException {
172         com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.updateFolder(folderId,
173                 parentFolderId, name, description);
174 
175         return DLFolderJSONSerializer.toJSONObject(returnValue);
176     }
177 }