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.bookmarks.service.http;
24  
25  import com.liferay.portlet.bookmarks.service.BookmarksEntryServiceUtil;
26  
27  import org.json.JSONObject;
28  
29  /**
30   * <a href="BookmarksEntryServiceJSON.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.bookmarks.service.BookmarksEntryServiceUtil</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.bookmarks.model.BookmarksEntry</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.bookmarks.service.http.BookmarksEntryJSONSerializer</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.bookmarks.service.BookmarksEntryServiceUtil
70   * @see com.liferay.portlet.bookmarks.service.http.BookmarksEntryJSONSerializer
71   *
72   */
73  public class BookmarksEntryServiceJSON {
74      public static JSONObject addEntry(long folderId, java.lang.String name,
75          java.lang.String url, java.lang.String comments,
76          java.lang.String[] tagsEntries, boolean addCommunityPermissions,
77          boolean addGuestPermissions)
78          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
79              com.liferay.portal.PortalException {
80          com.liferay.portlet.bookmarks.model.BookmarksEntry returnValue = BookmarksEntryServiceUtil.addEntry(folderId,
81                  name, url, comments, tagsEntries, addCommunityPermissions,
82                  addGuestPermissions);
83  
84          return BookmarksEntryJSONSerializer.toJSONObject(returnValue);
85      }
86  
87      public static JSONObject addEntry(long folderId, java.lang.String name,
88          java.lang.String url, java.lang.String comments,
89          java.lang.String[] tagsEntries,
90          java.lang.String[] communityPermissions,
91          java.lang.String[] guestPermissions)
92          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
93              com.liferay.portal.PortalException {
94          com.liferay.portlet.bookmarks.model.BookmarksEntry returnValue = BookmarksEntryServiceUtil.addEntry(folderId,
95                  name, url, comments, tagsEntries, communityPermissions,
96                  guestPermissions);
97  
98          return BookmarksEntryJSONSerializer.toJSONObject(returnValue);
99      }
100 
101     public static void deleteEntry(long entryId)
102         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
103             com.liferay.portal.PortalException {
104         BookmarksEntryServiceUtil.deleteEntry(entryId);
105     }
106 
107     public static JSONObject getEntry(long entryId)
108         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
109             com.liferay.portal.PortalException {
110         com.liferay.portlet.bookmarks.model.BookmarksEntry returnValue = BookmarksEntryServiceUtil.getEntry(entryId);
111 
112         return BookmarksEntryJSONSerializer.toJSONObject(returnValue);
113     }
114 
115     public static JSONObject openEntry(long entryId)
116         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
117             com.liferay.portal.PortalException {
118         com.liferay.portlet.bookmarks.model.BookmarksEntry returnValue = BookmarksEntryServiceUtil.openEntry(entryId);
119 
120         return BookmarksEntryJSONSerializer.toJSONObject(returnValue);
121     }
122 
123     public static JSONObject updateEntry(long entryId, long folderId,
124         java.lang.String name, java.lang.String url, java.lang.String comments,
125         java.lang.String[] tagsEntries)
126         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
127             com.liferay.portal.PortalException {
128         com.liferay.portlet.bookmarks.model.BookmarksEntry returnValue = BookmarksEntryServiceUtil.updateEntry(entryId,
129                 folderId, name, url, comments, tagsEntries);
130 
131         return BookmarksEntryJSONSerializer.toJSONObject(returnValue);
132     }
133 }