1   /**
2    * Copyright (c) 2000-2008 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.http;
24  
25  import com.liferay.portlet.documentlibrary.service.DLFileEntryServiceUtil;
26  
27  import org.json.JSONArray;
28  import org.json.JSONObject;
29  
30  /**
31   * <a href="DLFileEntryServiceJSON.java.html"><b><i>View Source</i></b></a>
32   *
33   * <p>
34   * ServiceBuilder generated this class. Modifications in this class will be
35   * overwritten the next time is generated.
36   * </p>
37   *
38   * <p>
39   * This class provides a JSON utility for the
40   * <code>com.liferay.portlet.documentlibrary.service.DLFileEntryServiceUtil</code>
41   * service utility. The static methods of this class calls the same methods of
42   * the service utility. However, the signatures are different because it is
43   * difficult for JSON to support certain types.
44   * </p>
45   *
46   * <p>
47   * ServiceBuilder follows certain rules in translating the methods. For example,
48   * if the method in the service utility returns a <code>java.util.List</code>,
49   * that is translated to a <code>org.json.JSONArray</code>. If the method in the
50   * service utility returns a <code>com.liferay.portlet.documentlibrary.model.DLFileEntry</code>,
51   * that is translated to a <code>org.json.JSONObject</code>. Methods that JSON
52   * cannot safely use are skipped. The logic for the translation is encapsulated
53   * in <code>com.liferay.portlet.documentlibrary.service.http.DLFileEntryJSONSerializer</code>.
54   * </p>
55   *
56   * <p>
57   * This allows you to call the the backend services directly from JavaScript.
58   * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
59   * reference of how that portlet uses the generated JavaScript in
60   * <code>portal-web/docroot/html/js/service.js</code> to call the backend
61   * services directly from JavaScript.
62   * </p>
63   *
64   * <p>
65   * The JSON utility is only generated for remote services.
66   * </p>
67   *
68   * @author Brian Wing Shun Chan
69   *
70   * @see com.liferay.portlet.documentlibrary.service.DLFileEntryServiceUtil
71   * @see com.liferay.portlet.documentlibrary.service.http.DLFileEntryJSONSerializer
72   *
73   */
74  public class DLFileEntryServiceJSON {
75      public static JSONObject addFileEntry(long folderId, java.lang.String name,
76          java.lang.String title, java.lang.String description,
77          java.lang.String[] tagsEntries, java.lang.String extraSettings,
78          byte[] byteArray, boolean addCommunityPermissions,
79          boolean addGuestPermissions)
80          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
81              com.liferay.portal.PortalException {
82          com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.addFileEntry(folderId,
83                  name, title, description, tagsEntries, extraSettings,
84                  byteArray, addCommunityPermissions, addGuestPermissions);
85  
86          return DLFileEntryJSONSerializer.toJSONObject(returnValue);
87      }
88  
89      public static JSONObject addFileEntry(long folderId, java.lang.String name,
90          java.lang.String title, java.lang.String description,
91          java.lang.String[] tagsEntries, java.lang.String extraSettings,
92          byte[] byteArray, java.lang.String[] communityPermissions,
93          java.lang.String[] guestPermissions)
94          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
95              com.liferay.portal.PortalException {
96          com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.addFileEntry(folderId,
97                  name, title, description, tagsEntries, extraSettings,
98                  byteArray, communityPermissions, guestPermissions);
99  
100         return DLFileEntryJSONSerializer.toJSONObject(returnValue);
101     }
102 
103     public static void deleteFileEntry(long folderId, java.lang.String name)
104         throws com.liferay.portal.SystemException,
105             com.liferay.portal.PortalException, java.rmi.RemoteException {
106         DLFileEntryServiceUtil.deleteFileEntry(folderId, name);
107     }
108 
109     public static void deleteFileEntry(long folderId, java.lang.String name,
110         double version)
111         throws com.liferay.portal.SystemException,
112             com.liferay.portal.PortalException, java.rmi.RemoteException {
113         DLFileEntryServiceUtil.deleteFileEntry(folderId, name, version);
114     }
115 
116     public static void deleteFileEntryByTitle(long folderId,
117         java.lang.String titleWithExtension)
118         throws com.liferay.portal.SystemException,
119             com.liferay.portal.PortalException, java.rmi.RemoteException {
120         DLFileEntryServiceUtil.deleteFileEntryByTitle(folderId,
121             titleWithExtension);
122     }
123 
124     public static JSONArray getFileEntries(long folderId)
125         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
126             com.liferay.portal.PortalException {
127         java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> returnValue =
128             DLFileEntryServiceUtil.getFileEntries(folderId);
129 
130         return DLFileEntryJSONSerializer.toJSONArray(returnValue);
131     }
132 
133     public static JSONObject getFileEntry(long folderId, java.lang.String name)
134         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
135             com.liferay.portal.PortalException {
136         com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.getFileEntry(folderId,
137                 name);
138 
139         return DLFileEntryJSONSerializer.toJSONObject(returnValue);
140     }
141 
142     public static JSONObject getFileEntryByTitle(long folderId,
143         java.lang.String titleWithExtension)
144         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
145             com.liferay.portal.PortalException {
146         com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.getFileEntryByTitle(folderId,
147                 titleWithExtension);
148 
149         return DLFileEntryJSONSerializer.toJSONObject(returnValue);
150     }
151 
152     public static void lockFileEntry(long folderId, java.lang.String name)
153         throws com.liferay.portal.SystemException,
154             com.liferay.portal.PortalException, java.rmi.RemoteException {
155         DLFileEntryServiceUtil.lockFileEntry(folderId, name);
156     }
157 
158     public static void unlockFileEntry(long folderId, java.lang.String name)
159         throws com.liferay.portal.SystemException,
160             com.liferay.portal.PortalException, java.rmi.RemoteException {
161         DLFileEntryServiceUtil.unlockFileEntry(folderId, name);
162     }
163 
164     public static JSONObject updateFileEntry(long folderId, long newFolderId,
165         java.lang.String name, java.lang.String sourceFileName,
166         java.lang.String title, java.lang.String description,
167         java.lang.String[] tagsEntries, java.lang.String extraSettings,
168         byte[] byteArray)
169         throws com.liferay.portal.SystemException,
170             com.liferay.portal.PortalException, java.rmi.RemoteException {
171         com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.updateFileEntry(folderId,
172                 newFolderId, name, sourceFileName, title, description,
173                 tagsEntries, extraSettings, byteArray);
174 
175         return DLFileEntryJSONSerializer.toJSONObject(returnValue);
176     }
177 }