com.liferay.portlet.tags.service.http
Class TagsPropertyServiceJSON

java.lang.Object
  extended bycom.liferay.portlet.tags.service.http.TagsPropertyServiceJSON

public class TagsPropertyServiceJSON
extends java.lang.Object

View Source

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

This class provides a JSON utility for the com.liferay.portlet.tags.service.TagsPropertyServiceUtil service utility. The static methods of this class calls the same methods of the service utility. However, the signatures are different because it is difficult for JSON to support certain types.

ServiceBuilder follows certain rules in translating the methods. For example, if the method in the service utility returns a java.util.List, that is translated to a org.json.JSONArray. If the method in the service utility returns a com.liferay.portlet.tags.model.TagsProperty, that is translated to a org.json.JSONObject. Methods that JSON cannot safely use are skipped. The logic for the translation is encapsulated in com.liferay.portlet.tags.service.http.TagsPropertyJSONSerializer.

This allows you to call the the backend services directly from JavaScript. See portal-web/docroot/html/portlet/tags_admin/unpacked.js for a reference of how that portlet uses the generated JavaScript in portal-web/docroot/html/js/service.js to call the backend services directly from JavaScript.

The JSON utility is only generated for remote services.

Author:
Brian Wing Shun Chan
See Also:
TagsPropertyServiceUtil, TagsPropertyJSONSerializer

Constructor Summary
TagsPropertyServiceJSON()
           
 
Method Summary
static org.json.JSONObject addProperty(long entryId, java.lang.String key, java.lang.String value)
           
static org.json.JSONObject addProperty(java.lang.String entryName, java.lang.String key, java.lang.String value)
           
static void deleteProperty(long propertyId)
           
static org.json.JSONArray getProperties(long entryId)
           
static org.json.JSONArray getPropertyValues(long companyId, java.lang.String key)
           
static org.json.JSONObject updateProperty(long propertyId, java.lang.String key, java.lang.String value)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TagsPropertyServiceJSON

public TagsPropertyServiceJSON()
Method Detail

addProperty

public static org.json.JSONObject addProperty(long entryId,
                                              java.lang.String key,
                                              java.lang.String value)
                                       throws com.liferay.portal.SystemException,
                                              com.liferay.portal.PortalException,
                                              java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

addProperty

public static org.json.JSONObject addProperty(java.lang.String entryName,
                                              java.lang.String key,
                                              java.lang.String value)
                                       throws com.liferay.portal.SystemException,
                                              com.liferay.portal.PortalException,
                                              java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

deleteProperty

public static void deleteProperty(long propertyId)
                           throws com.liferay.portal.SystemException,
                                  com.liferay.portal.PortalException,
                                  java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getProperties

public static org.json.JSONArray getProperties(long entryId)
                                        throws com.liferay.portal.SystemException,
                                               java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
java.rmi.RemoteException

getPropertyValues

public static org.json.JSONArray getPropertyValues(long companyId,
                                                   java.lang.String key)
                                            throws com.liferay.portal.SystemException,
                                                   java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
java.rmi.RemoteException

updateProperty

public static org.json.JSONObject updateProperty(long propertyId,
                                                 java.lang.String key,
                                                 java.lang.String value)
                                          throws com.liferay.portal.SystemException,
                                                 com.liferay.portal.PortalException,
                                                 java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException