com.liferay.portal.service.http
Class AddressServiceJSON

java.lang.Object
  com.liferay.portal.service.http.AddressServiceJSON

public class AddressServiceJSON
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.AddressServiceUtil 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.Address, 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.AddressJSONSerializer.

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:

AddressServiceUtil, AddressJSONSerializer

Constructor Summary

AddressServiceJSON()

Method Summary

static com.liferay.portal.kernel.json.JSONObject	addAddress(java.lang.String className, long classPK, java.lang.String street1, java.lang.String street2, java.lang.String street3, java.lang.String city, java.lang.String zip, long regionId, long countryId, int typeId, boolean mailing, boolean primary)
static void	deleteAddress(long addressId)
static com.liferay.portal.kernel.json.JSONObject	getAddress(long addressId)
static com.liferay.portal.kernel.json.JSONArray	getAddresses(java.lang.String className, long classPK)
static com.liferay.portal.kernel.json.JSONObject	updateAddress(long addressId, java.lang.String street1, java.lang.String street2, java.lang.String street3, java.lang.String city, java.lang.String zip, long regionId, long countryId, int typeId, boolean mailing, boolean primary)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AddressServiceJSON

public AddressServiceJSON()

Method Detail

addAddress

public static com.liferay.portal.kernel.json.JSONObject addAddress(java.lang.String className,
                                                                   long classPK,
                                                                   java.lang.String street1,
                                                                   java.lang.String street2,
                                                                   java.lang.String street3,
                                                                   java.lang.String city,
                                                                   java.lang.String zip,
                                                                   long regionId,
                                                                   long countryId,
                                                                   int typeId,
                                                                   boolean mailing,
                                                                   boolean primary)
                                                            throws com.liferay.portal.PortalException,
                                                                   com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

deleteAddress

public static void deleteAddress(long addressId)
                          throws com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getAddress

public static com.liferay.portal.kernel.json.JSONObject getAddress(long addressId)
                                                            throws com.liferay.portal.PortalException,
                                                                   com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getAddresses

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

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateAddress

public static com.liferay.portal.kernel.json.JSONObject updateAddress(long addressId,
                                                                      java.lang.String street1,
                                                                      java.lang.String street2,
                                                                      java.lang.String street3,
                                                                      java.lang.String city,
                                                                      java.lang.String zip,
                                                                      long regionId,
                                                                      long countryId,
                                                                      int typeId,
                                                                      boolean mailing,
                                                                      boolean primary)
                                                               throws com.liferay.portal.PortalException,
                                                                      com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException