com.liferay.portal.service.http
Class RegionServiceJSON
java.lang.Object
com.liferay.portal.service.http.RegionServiceJSON
public class RegionServiceJSON
- 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.RegionServiceUtil
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.Region
,
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.RegionJSONSerializer
.
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:
RegionServiceUtil
,
RegionJSONSerializer
Method Summary |
static com.liferay.portal.kernel.json.JSONObject |
addRegion(long countryId,
java.lang.String regionCode,
java.lang.String name,
boolean active)
|
static com.liferay.portal.kernel.json.JSONObject |
getRegion(long regionId)
|
static com.liferay.portal.kernel.json.JSONArray |
getRegions()
|
static com.liferay.portal.kernel.json.JSONArray |
getRegions(boolean active)
|
static com.liferay.portal.kernel.json.JSONArray |
getRegions(long countryId)
|
static com.liferay.portal.kernel.json.JSONArray |
getRegions(long countryId,
boolean active)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
RegionServiceJSON
public RegionServiceJSON()
addRegion
public static com.liferay.portal.kernel.json.JSONObject addRegion(long countryId,
java.lang.String regionCode,
java.lang.String name,
boolean active)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException
getRegions
public static com.liferay.portal.kernel.json.JSONArray getRegions()
throws java.rmi.RemoteException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
getRegions
public static com.liferay.portal.kernel.json.JSONArray getRegions(long countryId)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
getRegions
public static com.liferay.portal.kernel.json.JSONArray getRegions(boolean active)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
getRegions
public static com.liferay.portal.kernel.json.JSONArray getRegions(long countryId,
boolean active)
throws java.rmi.RemoteException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
getRegion
public static com.liferay.portal.kernel.json.JSONObject getRegion(long regionId)
throws java.rmi.RemoteException,
com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException