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.tags.service.http;
022:
023: import com.liferay.portlet.tags.service.TagsPropertyServiceUtil;
024:
025: import org.json.JSONArray;
026: import org.json.JSONObject;
027:
028: /**
029: * <a href="TagsPropertyServiceJSON.java.html"><b><i>View Source</i></b></a>
030: *
031: * <p>
032: * ServiceBuilder generated this class. Modifications in this class will be
033: * overwritten the next time is generated.
034: * </p>
035: *
036: * <p>
037: * This class provides a JSON utility for the
038: * <code>com.liferay.portlet.tags.service.TagsPropertyServiceUtil</code>
039: * service utility. The static methods of this class calls the same methods of
040: * the service utility. However, the signatures are different because it is
041: * difficult for JSON to support certain types.
042: * </p>
043: *
044: * <p>
045: * ServiceBuilder follows certain rules in translating the methods. For example,
046: * if the method in the service utility returns a <code>java.util.List</code>,
047: * that is translated to a <code>org.json.JSONArray</code>. If the method in the
048: * service utility returns a <code>com.liferay.portlet.tags.model.TagsProperty</code>,
049: * that is translated to a <code>org.json.JSONObject</code>. Methods that JSON
050: * cannot safely use are skipped. The logic for the translation is encapsulated
051: * in <code>com.liferay.portlet.tags.service.http.TagsPropertyJSONSerializer</code>.
052: * </p>
053: *
054: * <p>
055: * This allows you to call the the backend services directly from JavaScript.
056: * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
057: * reference of how that portlet uses the generated JavaScript in
058: * <code>portal-web/docroot/html/js/service.js</code> to call the backend
059: * services directly from JavaScript.
060: * </p>
061: *
062: * <p>
063: * The JSON utility is only generated for remote services.
064: * </p>
065: *
066: * @author Brian Wing Shun Chan
067: *
068: * @see com.liferay.portlet.tags.service.TagsPropertyServiceUtil
069: * @see com.liferay.portlet.tags.service.http.TagsPropertyJSONSerializer
070: *
071: */
072: public class TagsPropertyServiceJSON {
073: public static JSONObject addProperty(long entryId,
074: java.lang.String key, java.lang.String value)
075: throws java.rmi.RemoteException,
076: com.liferay.portal.SystemException,
077: com.liferay.portal.PortalException {
078: com.liferay.portlet.tags.model.TagsProperty returnValue = TagsPropertyServiceUtil
079: .addProperty(entryId, key, value);
080:
081: return TagsPropertyJSONSerializer.toJSONObject(returnValue);
082: }
083:
084: public static JSONObject addProperty(java.lang.String entryName,
085: java.lang.String key, java.lang.String value)
086: throws java.rmi.RemoteException,
087: com.liferay.portal.SystemException,
088: com.liferay.portal.PortalException {
089: com.liferay.portlet.tags.model.TagsProperty returnValue = TagsPropertyServiceUtil
090: .addProperty(entryName, key, value);
091:
092: return TagsPropertyJSONSerializer.toJSONObject(returnValue);
093: }
094:
095: public static void deleteProperty(long propertyId)
096: throws java.rmi.RemoteException,
097: com.liferay.portal.SystemException,
098: com.liferay.portal.PortalException {
099: TagsPropertyServiceUtil.deleteProperty(propertyId);
100: }
101:
102: public static JSONArray getProperties(long entryId)
103: throws java.rmi.RemoteException,
104: com.liferay.portal.SystemException {
105: java.util.List returnValue = TagsPropertyServiceUtil
106: .getProperties(entryId);
107:
108: return TagsPropertyJSONSerializer.toJSONArray(returnValue);
109: }
110:
111: public static JSONArray getPropertyValues(long companyId,
112: java.lang.String key) throws java.rmi.RemoteException,
113: com.liferay.portal.SystemException {
114: java.util.List returnValue = TagsPropertyServiceUtil
115: .getPropertyValues(companyId, key);
116:
117: return TagsPropertyJSONSerializer.toJSONArray(returnValue);
118: }
119:
120: public static JSONObject updateProperty(long propertyId,
121: java.lang.String key, java.lang.String value)
122: throws java.rmi.RemoteException,
123: com.liferay.portal.SystemException,
124: com.liferay.portal.PortalException {
125: com.liferay.portlet.tags.model.TagsProperty returnValue = TagsPropertyServiceUtil
126: .updateProperty(propertyId, key, value);
127:
128: return TagsPropertyJSONSerializer.toJSONObject(returnValue);
129: }
130: }
|