com.liferay.portal.service.http
Class EmailAddressServiceJSON

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

public class EmailAddressServiceJSON
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.EmailAddressServiceUtil 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.portal.model.EmailAddress, 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.portal.service.http.EmailAddressJSONSerializer.

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:
EmailAddressServiceUtil, EmailAddressJSONSerializer

Constructor Summary
EmailAddressServiceJSON()
           
 
Method Summary
static org.json.JSONObject addEmailAddress(java.lang.String className, long classPK, java.lang.String address, int typeId, boolean primary)
           
static void deleteEmailAddress(long emailAddressId)
           
static org.json.JSONObject getEmailAddress(long emailAddressId)
           
static org.json.JSONArray getEmailAddresses(java.lang.String className, long classPK)
           
static org.json.JSONObject updateEmailAddress(long emailAddressId, java.lang.String address, int typeId, boolean primary)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EmailAddressServiceJSON

public EmailAddressServiceJSON()
Method Detail

addEmailAddress

public static org.json.JSONObject addEmailAddress(java.lang.String className,
                                                  long classPK,
                                                  java.lang.String address,
                                                  int typeId,
                                                  boolean primary)
                                           throws java.rmi.RemoteException,
                                                  com.liferay.portal.SystemException,
                                                  com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

deleteEmailAddress

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

getEmailAddress

public static org.json.JSONObject getEmailAddress(long emailAddressId)
                                           throws java.rmi.RemoteException,
                                                  com.liferay.portal.SystemException,
                                                  com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getEmailAddresses

public static org.json.JSONArray getEmailAddresses(java.lang.String className,
                                                   long classPK)
                                            throws java.rmi.RemoteException,
                                                   com.liferay.portal.SystemException,
                                                   com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

updateEmailAddress

public static org.json.JSONObject updateEmailAddress(long emailAddressId,
                                                     java.lang.String address,
                                                     int typeId,
                                                     boolean primary)
                                              throws java.rmi.RemoteException,
                                                     com.liferay.portal.SystemException,
                                                     com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException