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.JSONObject;
28  
29  /**
30   * <a href="DLFileEntryServiceJSON.java.html"><b><i>View Source</i></b></a>
31   *
32   * <p>
33   * ServiceBuilder generated this class. Modifications in this class will be
34   * overwritten the next time is generated.
35   * </p>
36   *
37   * <p>
38   * This class provides a JSON utility for the
39   * <code>com.liferay.portlet.documentlibrary.service.DLFileEntryServiceUtil</code>
40   * service utility. The static methods of this class calls the same methods of
41   * the service utility. However, the signatures are different because it is
42   * difficult for JSON to support certain types.
43   * </p>
44   *
45   * <p>
46   * ServiceBuilder follows certain rules in translating the methods. For example,
47   * if the method in the service utility returns a <code>java.util.List</code>,
48   * that is translated to a <code>org.json.JSONArray</code>. If the method in the
49   * service utility returns a <code>com.liferay.portlet.documentlibrary.model.DLFileEntry</code>,
50   * that is translated to a <code>org.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.DLFileEntryJSONSerializer</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.DLFileEntryServiceUtil
70   * @see com.liferay.portlet.documentlibrary.service.http.DLFileEntryJSONSerializer
71   *
72   */
73  public class DLFileEntryServiceJSON {
74      public static JSONObject addFileEntry(long folderId, java.lang.String name,
75          java.lang.String title, java.lang.String description,
76          java.lang.String[] tagsEntries, java.lang.String extraSettings,
77          byte[] byteArray, boolean addCommunityPermissions,
78          boolean addGuestPermissions)
79          throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
80              com.liferay.portal.PortalException {
81          com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.addFileEntry(folderId,
82                  name, title, description, tagsEntries, extraSettings,
83                  byteArray, addCommunityPermissions, addGuestPermissions);
84  
85          return DLFileEntryJSONSerializer.toJSONObject(returnValue);
86      }
87  
88      public static JSONObject addFileEntry(long folderId, java.lang.String name,
89          java.lang.String title, java.lang.String description,
90          java.lang.String[] tagsEntries, java.lang.String extraSettings,
91          byte[] byteArray, java.lang.String[] communityPermissions,
92          java.lang.String[] guestPermissions)
93          throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
94              com.liferay.portal.PortalException {
95          com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.addFileEntry(folderId,
96                  name, title, description, tagsEntries, extraSettings,
97                  byteArray, communityPermissions, guestPermissions);
98  
99          return DLFileEntryJSONSerializer.toJSONObject(returnValue);
100     }
101 
102     public static void deleteFileEntry(long folderId, java.lang.String name)
103         throws com.liferay.portal.SystemException, 
104             com.liferay.portal.PortalException, java.rmi.RemoteException {
105         DLFileEntryServiceUtil.deleteFileEntry(folderId, name);
106     }
107 
108     public static void deleteFileEntry(long folderId, java.lang.String name,
109         double version)
110         throws com.liferay.portal.SystemException, 
111             com.liferay.portal.PortalException, java.rmi.RemoteException {
112         DLFileEntryServiceUtil.deleteFileEntry(folderId, name, version);
113     }
114 
115     public static void deleteFileEntryByTitle(long folderId,
116         java.lang.String titleWithExtension)
117         throws com.liferay.portal.SystemException, 
118             com.liferay.portal.PortalException, java.rmi.RemoteException {
119         DLFileEntryServiceUtil.deleteFileEntryByTitle(folderId,
120             titleWithExtension);
121     }
122 
123     public static JSONObject getFileEntry(long folderId, java.lang.String name)
124         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
125             com.liferay.portal.PortalException {
126         com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.getFileEntry(folderId,
127                 name);
128 
129         return DLFileEntryJSONSerializer.toJSONObject(returnValue);
130     }
131 
132     public static JSONObject getFileEntryByTitle(long folderId,
133         java.lang.String titleWithExtension)
134         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
135             com.liferay.portal.PortalException {
136         com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.getFileEntryByTitle(folderId,
137                 titleWithExtension);
138 
139         return DLFileEntryJSONSerializer.toJSONObject(returnValue);
140     }
141 
142     public static void lockFileEntry(long folderId, java.lang.String name)
143         throws com.liferay.portal.SystemException, 
144             com.liferay.portal.PortalException, java.rmi.RemoteException {
145         DLFileEntryServiceUtil.lockFileEntry(folderId, name);
146     }
147 
148     public static void unlockFileEntry(long folderId, java.lang.String name)
149         throws com.liferay.portal.SystemException, 
150             com.liferay.portal.PortalException, java.rmi.RemoteException {
151         DLFileEntryServiceUtil.unlockFileEntry(folderId, name);
152     }
153 
154     public static JSONObject updateFileEntry(long folderId, long newFolderId,
155         java.lang.String name, java.lang.String sourceFileName,
156         java.lang.String title, java.lang.String description,
157         java.lang.String[] tagsEntries, java.lang.String extraSettings,
158         byte[] byteArray)
159         throws com.liferay.portal.SystemException, 
160             com.liferay.portal.PortalException, java.rmi.RemoteException {
161         com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.updateFileEntry(folderId,
162                 newFolderId, name, sourceFileName, title, description,
163                 tagsEntries, extraSettings, byteArray);
164 
165         return DLFileEntryJSONSerializer.toJSONObject(returnValue);
166     }
167 }