com.liferay.portal.service.http
Class EmailAddressServiceJSON
java.lang.Object
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
com.liferay.portal.kernel.json.JSONArray
. If the method in the
service utility returns a com.liferay.portal.model.EmailAddress
,
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.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
Method Summary |
static com.liferay.portal.kernel.json.JSONObject |
addEmailAddress(java.lang.String className,
long classPK,
java.lang.String address,
int typeId,
boolean primary)
|
static void |
deleteEmailAddress(long emailAddressId)
|
static com.liferay.portal.kernel.json.JSONObject |
getEmailAddress(long emailAddressId)
|
static com.liferay.portal.kernel.json.JSONArray |
getEmailAddresses(java.lang.String className,
long classPK)
|
static com.liferay.portal.kernel.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 |
EmailAddressServiceJSON
public EmailAddressServiceJSON()
addEmailAddress
public static com.liferay.portal.kernel.json.JSONObject addEmailAddress(java.lang.String className,
long classPK,
java.lang.String address,
int typeId,
boolean primary)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
deleteEmailAddress
public static void deleteEmailAddress(long emailAddressId)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
getEmailAddress
public static com.liferay.portal.kernel.json.JSONObject getEmailAddress(long emailAddressId)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
getEmailAddresses
public static com.liferay.portal.kernel.json.JSONArray getEmailAddresses(java.lang.String className,
long classPK)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
updateEmailAddress
public static com.liferay.portal.kernel.json.JSONObject updateEmailAddress(long emailAddressId,
java.lang.String address,
int typeId,
boolean primary)
throws com.liferay.portal.PortalException,
com.liferay.portal.SystemException
- Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException