001: /**
002: * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
003: *
004: * Permission is hereby granted, free of charge, to any person obtaining a copy
005: * of this software and associated documentation files (the "Software"), to deal
006: * in the Software without restriction, including without limitation the rights
007: * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
008: * copies of the Software, and to permit persons to whom the Software is
009: * furnished to do so, subject to the following conditions:
010: *
011: * The above copyright notice and this permission notice shall be included in
012: * all copies or substantial portions of the Software.
013: *
014: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
015: * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
016: * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
017: * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
018: * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
019: * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
020: * SOFTWARE.
021: */package com.liferay.portlet.bookmarks.service.http;
022:
023: import com.liferay.portlet.bookmarks.service.BookmarksEntryServiceUtil;
024:
025: import org.json.JSONObject;
026:
027: /**
028: * <a href="BookmarksEntryServiceJSON.java.html"><b><i>View Source</i></b></a>
029: *
030: * <p>
031: * ServiceBuilder generated this class. Modifications in this class will be
032: * overwritten the next time is generated.
033: * </p>
034: *
035: * <p>
036: * This class provides a JSON utility for the
037: * <code>com.liferay.portlet.bookmarks.service.BookmarksEntryServiceUtil</code>
038: * service utility. The static methods of this class calls the same methods of
039: * the service utility. However, the signatures are different because it is
040: * difficult for JSON to support certain types.
041: * </p>
042: *
043: * <p>
044: * ServiceBuilder follows certain rules in translating the methods. For example,
045: * if the method in the service utility returns a <code>java.util.List</code>,
046: * that is translated to a <code>org.json.JSONArray</code>. If the method in the
047: * service utility returns a <code>com.liferay.portlet.bookmarks.model.BookmarksEntry</code>,
048: * that is translated to a <code>org.json.JSONObject</code>. Methods that JSON
049: * cannot safely use are skipped. The logic for the translation is encapsulated
050: * in <code>com.liferay.portlet.bookmarks.service.http.BookmarksEntryJSONSerializer</code>.
051: * </p>
052: *
053: * <p>
054: * This allows you to call the the backend services directly from JavaScript.
055: * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
056: * reference of how that portlet uses the generated JavaScript in
057: * <code>portal-web/docroot/html/js/service.js</code> to call the backend
058: * services directly from JavaScript.
059: * </p>
060: *
061: * <p>
062: * The JSON utility is only generated for remote services.
063: * </p>
064: *
065: * @author Brian Wing Shun Chan
066: *
067: * @see com.liferay.portlet.bookmarks.service.BookmarksEntryServiceUtil
068: * @see com.liferay.portlet.bookmarks.service.http.BookmarksEntryJSONSerializer
069: *
070: */
071: public class BookmarksEntryServiceJSON {
072: public static JSONObject addEntry(long folderId,
073: java.lang.String name, java.lang.String url,
074: java.lang.String comments, java.lang.String[] tagsEntries,
075: boolean addCommunityPermissions, boolean addGuestPermissions)
076: throws java.rmi.RemoteException,
077: com.liferay.portal.SystemException,
078: com.liferay.portal.PortalException {
079: com.liferay.portlet.bookmarks.model.BookmarksEntry returnValue = BookmarksEntryServiceUtil
080: .addEntry(folderId, name, url, comments, tagsEntries,
081: addCommunityPermissions, addGuestPermissions);
082:
083: return BookmarksEntryJSONSerializer.toJSONObject(returnValue);
084: }
085:
086: public static JSONObject addEntry(long folderId,
087: java.lang.String name, java.lang.String url,
088: java.lang.String comments, java.lang.String[] tagsEntries,
089: java.lang.String[] communityPermissions,
090: java.lang.String[] guestPermissions)
091: throws java.rmi.RemoteException,
092: com.liferay.portal.SystemException,
093: com.liferay.portal.PortalException {
094: com.liferay.portlet.bookmarks.model.BookmarksEntry returnValue = BookmarksEntryServiceUtil
095: .addEntry(folderId, name, url, comments, tagsEntries,
096: communityPermissions, guestPermissions);
097:
098: return BookmarksEntryJSONSerializer.toJSONObject(returnValue);
099: }
100:
101: public static void deleteEntry(long entryId)
102: throws java.rmi.RemoteException,
103: com.liferay.portal.SystemException,
104: com.liferay.portal.PortalException {
105: BookmarksEntryServiceUtil.deleteEntry(entryId);
106: }
107:
108: public static JSONObject getEntry(long entryId)
109: throws java.rmi.RemoteException,
110: com.liferay.portal.SystemException,
111: com.liferay.portal.PortalException {
112: com.liferay.portlet.bookmarks.model.BookmarksEntry returnValue = BookmarksEntryServiceUtil
113: .getEntry(entryId);
114:
115: return BookmarksEntryJSONSerializer.toJSONObject(returnValue);
116: }
117:
118: public static JSONObject openEntry(long entryId)
119: throws java.rmi.RemoteException,
120: com.liferay.portal.SystemException,
121: com.liferay.portal.PortalException {
122: com.liferay.portlet.bookmarks.model.BookmarksEntry returnValue = BookmarksEntryServiceUtil
123: .openEntry(entryId);
124:
125: return BookmarksEntryJSONSerializer.toJSONObject(returnValue);
126: }
127:
128: public static JSONObject updateEntry(long entryId, long folderId,
129: java.lang.String name, java.lang.String url,
130: java.lang.String comments, java.lang.String[] tagsEntries)
131: throws java.rmi.RemoteException,
132: com.liferay.portal.SystemException,
133: com.liferay.portal.PortalException {
134: com.liferay.portlet.bookmarks.model.BookmarksEntry returnValue = BookmarksEntryServiceUtil
135: .updateEntry(entryId, folderId, name, url, comments,
136: tagsEntries);
137:
138: return BookmarksEntryJSONSerializer.toJSONObject(returnValue);
139: }
140: }
|