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.http;
24  
25  import com.liferay.portal.kernel.json.JSONArray;
26  import com.liferay.portal.kernel.json.JSONObject;
27  
28  import com.liferay.portlet.documentlibrary.service.DLFileEntryServiceUtil;
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
50   * <code>com.liferay.portal.kernel.json.JSONArray</code>. If the method in the
51   * service utility returns a <code>com.liferay.portlet.documentlibrary.model.DLFileEntry</code>,
52   * that is translated to a
53   * <code>com.liferay.portal.kernel.json.JSONObject</code>. Methods that JSON
54   * cannot safely use are skipped. The logic for the translation is encapsulated
55   * in <code>com.liferay.portlet.documentlibrary.service.http.DLFileEntryJSONSerializer</code>.
56   * </p>
57   *
58   * <p>
59   * This allows you to call the the backend services directly from JavaScript.
60   * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
61   * reference of how that portlet uses the generated JavaScript in
62   * <code>portal-web/docroot/html/js/service.js</code> to call the backend
63   * services directly from JavaScript.
64   * </p>
65   *
66   * <p>
67   * The JSON utility is only generated for remote services.
68   * </p>
69   *
70   * @author Brian Wing Shun Chan
71   *
72   * @see com.liferay.portlet.documentlibrary.service.DLFileEntryServiceUtil
73   * @see com.liferay.portlet.documentlibrary.service.http.DLFileEntryJSONSerializer
74   *
75   */
76  public class DLFileEntryServiceJSON {
77      public static JSONObject addFileEntry(long folderId, java.lang.String name,
78          java.lang.String title, java.lang.String description,
79          java.lang.String[] tagsEntries, java.lang.String extraSettings,
80          byte[] bytes, boolean addCommunityPermissions,
81          boolean addGuestPermissions)
82          throws com.liferay.portal.PortalException,
83              com.liferay.portal.SystemException {
84          com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.addFileEntry(folderId,
85                  name, title, description, tagsEntries, extraSettings, bytes,
86                  addCommunityPermissions, addGuestPermissions);
87  
88          return DLFileEntryJSONSerializer.toJSONObject(returnValue);
89      }
90  
91      public static JSONObject addFileEntry(long folderId, java.lang.String name,
92          java.lang.String title, java.lang.String description,
93          java.lang.String[] tagsEntries, java.lang.String extraSettings,
94          byte[] bytes, java.lang.String[] communityPermissions,
95          java.lang.String[] guestPermissions)
96          throws com.liferay.portal.PortalException,
97              com.liferay.portal.SystemException {
98          com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.addFileEntry(folderId,
99                  name, title, description, tagsEntries, extraSettings, bytes,
100                 communityPermissions, guestPermissions);
101 
102         return DLFileEntryJSONSerializer.toJSONObject(returnValue);
103     }
104 
105     public static void deleteFileEntry(long folderId, java.lang.String name)
106         throws com.liferay.portal.PortalException,
107             com.liferay.portal.SystemException {
108         DLFileEntryServiceUtil.deleteFileEntry(folderId, name);
109     }
110 
111     public static void deleteFileEntry(long folderId, java.lang.String name,
112         double version)
113         throws com.liferay.portal.PortalException,
114             com.liferay.portal.SystemException {
115         DLFileEntryServiceUtil.deleteFileEntry(folderId, name, version);
116     }
117 
118     public static void deleteFileEntryByTitle(long folderId,
119         java.lang.String titleWithExtension)
120         throws com.liferay.portal.PortalException,
121             com.liferay.portal.SystemException {
122         DLFileEntryServiceUtil.deleteFileEntryByTitle(folderId,
123             titleWithExtension);
124     }
125 
126     public static JSONArray getFileEntries(long folderId)
127         throws com.liferay.portal.PortalException,
128             com.liferay.portal.SystemException {
129         java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> returnValue =
130             DLFileEntryServiceUtil.getFileEntries(folderId);
131 
132         return DLFileEntryJSONSerializer.toJSONArray(returnValue);
133     }
134 
135     public static JSONObject getFileEntry(long folderId, java.lang.String name)
136         throws com.liferay.portal.PortalException,
137             com.liferay.portal.SystemException {
138         com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.getFileEntry(folderId,
139                 name);
140 
141         return DLFileEntryJSONSerializer.toJSONObject(returnValue);
142     }
143 
144     public static JSONObject getFileEntryByTitle(long folderId,
145         java.lang.String titleWithExtension)
146         throws com.liferay.portal.PortalException,
147             com.liferay.portal.SystemException {
148         com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.getFileEntryByTitle(folderId,
149                 titleWithExtension);
150 
151         return DLFileEntryJSONSerializer.toJSONObject(returnValue);
152     }
153 
154     public static boolean hasFileEntryLock(long folderId, java.lang.String name)
155         throws com.liferay.portal.PortalException {
156         boolean returnValue = DLFileEntryServiceUtil.hasFileEntryLock(folderId,
157                 name);
158 
159         return returnValue;
160     }
161 
162     public static com.liferay.lock.model.Lock lockFileEntry(long folderId,
163         java.lang.String name)
164         throws com.liferay.portal.PortalException,
165             com.liferay.portal.SystemException {
166         com.liferay.lock.model.Lock returnValue = DLFileEntryServiceUtil.lockFileEntry(folderId,
167                 name);
168 
169         return returnValue;
170     }
171 
172     public static com.liferay.lock.model.Lock lockFileEntry(long folderId,
173         java.lang.String name, java.lang.String owner, long expirationTime)
174         throws com.liferay.portal.PortalException,
175             com.liferay.portal.SystemException {
176         com.liferay.lock.model.Lock returnValue = DLFileEntryServiceUtil.lockFileEntry(folderId,
177                 name, owner, expirationTime);
178 
179         return returnValue;
180     }
181 
182     public static com.liferay.lock.model.Lock refreshFileEntryLock(
183         java.lang.String lockUuid, long expirationTime)
184         throws com.liferay.portal.PortalException {
185         com.liferay.lock.model.Lock returnValue = DLFileEntryServiceUtil.refreshFileEntryLock(lockUuid,
186                 expirationTime);
187 
188         return returnValue;
189     }
190 
191     public static void unlockFileEntry(long folderId, java.lang.String name) {
192         DLFileEntryServiceUtil.unlockFileEntry(folderId, name);
193     }
194 
195     public static void unlockFileEntry(long folderId, java.lang.String name,
196         java.lang.String lockUuid) throws com.liferay.portal.PortalException {
197         DLFileEntryServiceUtil.unlockFileEntry(folderId, name, lockUuid);
198     }
199 
200     public static JSONObject updateFileEntry(long folderId, long newFolderId,
201         java.lang.String name, java.lang.String sourceFileName,
202         java.lang.String title, java.lang.String description,
203         java.lang.String[] tagsEntries, java.lang.String extraSettings,
204         byte[] bytes)
205         throws com.liferay.portal.PortalException,
206             com.liferay.portal.SystemException {
207         com.liferay.portlet.documentlibrary.model.DLFileEntry returnValue = DLFileEntryServiceUtil.updateFileEntry(folderId,
208                 newFolderId, name, sourceFileName, title, description,
209                 tagsEntries, extraSettings, bytes);
210 
211         return DLFileEntryJSONSerializer.toJSONObject(returnValue);
212     }
213 
214     public static boolean verifyFileEntryLock(long folderId,
215         java.lang.String name, java.lang.String lockUuid)
216         throws com.liferay.portal.PortalException {
217         boolean returnValue = DLFileEntryServiceUtil.verifyFileEntryLock(folderId,
218                 name, lockUuid);
219 
220         return returnValue;
221     }
222 }