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