com.liferay.portal.service.http
Class PhoneServiceJSON

java.lang.Object
  extended by com.liferay.portal.service.http.PhoneServiceJSON

public class PhoneServiceJSON
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.portal.service.PhoneServiceUtil 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 com.liferay.portal.kernel.json.JSONArray. If the method in the service utility returns a com.liferay.portal.model.Phone, that is translated to a com.liferay.portal.kernel.json.JSONObject. Methods that JSON cannot safely use are skipped. The logic for the translation is encapsulated in com.liferay.portal.service.http.PhoneJSONSerializer.

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:
PhoneServiceUtil, PhoneJSONSerializer

Constructor Summary
PhoneServiceJSON()
           
 
Method Summary
static com.liferay.portal.kernel.json.JSONObject addPhone(java.lang.String className, long classPK, java.lang.String number, java.lang.String extension, int typeId, boolean primary)
           
static void deletePhone(long phoneId)
           
static com.liferay.portal.kernel.json.JSONObject getPhone(long phoneId)
           
static com.liferay.portal.kernel.json.JSONArray getPhones(java.lang.String className, long classPK)
           
static com.liferay.portal.kernel.json.JSONObject updatePhone(long phoneId, java.lang.String number, java.lang.String extension, int typeId, boolean primary)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PhoneServiceJSON

public PhoneServiceJSON()
Method Detail

addPhone

public static com.liferay.portal.kernel.json.JSONObject addPhone(java.lang.String className,
                                                                 long classPK,
                                                                 java.lang.String number,
                                                                 java.lang.String extension,
                                                                 int typeId,
                                                                 boolean primary)
                                                          throws com.liferay.portal.PortalException,
                                                                 com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

deletePhone

public static void deletePhone(long phoneId)
                        throws com.liferay.portal.PortalException,
                               com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getPhone

public static com.liferay.portal.kernel.json.JSONObject getPhone(long phoneId)
                                                          throws com.liferay.portal.PortalException,
                                                                 com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getPhones

public static com.liferay.portal.kernel.json.JSONArray getPhones(java.lang.String className,
                                                                 long classPK)
                                                          throws com.liferay.portal.PortalException,
                                                                 com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updatePhone

public static com.liferay.portal.kernel.json.JSONObject updatePhone(long phoneId,
                                                                    java.lang.String number,
                                                                    java.lang.String extension,
                                                                    int typeId,
                                                                    boolean primary)
                                                             throws com.liferay.portal.PortalException,
                                                                    com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException