com.liferay.portlet.announcements.service.http
Class AnnouncementsEntryServiceJSON

java.lang.Object
  extended by com.liferay.portlet.announcements.service.http.AnnouncementsEntryServiceJSON

public class AnnouncementsEntryServiceJSON
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.portlet.announcements.service.AnnouncementsEntryServiceUtil 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.portlet.announcements.model.AnnouncementsEntry, 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.portlet.announcements.service.http.AnnouncementsEntryJSONSerializer.

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:
AnnouncementsEntryServiceUtil, AnnouncementsEntryJSONSerializer

Constructor Summary
AnnouncementsEntryServiceJSON()
           
 
Method Summary
static org.json.JSONObject addEntry(long plid, long classNameId, long classPK, java.lang.String title, java.lang.String content, java.lang.String url, java.lang.String type, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, int priority, boolean alert)
           
static void deleteEntry(long entryId)
           
static org.json.JSONObject updateEntry(long entryId, java.lang.String title, java.lang.String content, java.lang.String url, java.lang.String type, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, int priority)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AnnouncementsEntryServiceJSON

public AnnouncementsEntryServiceJSON()
Method Detail

addEntry

public static org.json.JSONObject addEntry(long plid,
                                           long classNameId,
                                           long classPK,
                                           java.lang.String title,
                                           java.lang.String content,
                                           java.lang.String url,
                                           java.lang.String type,
                                           int displayDateMonth,
                                           int displayDateDay,
                                           int displayDateYear,
                                           int displayDateHour,
                                           int displayDateMinute,
                                           int expirationDateMonth,
                                           int expirationDateDay,
                                           int expirationDateYear,
                                           int expirationDateHour,
                                           int expirationDateMinute,
                                           int priority,
                                           boolean alert)
                                    throws java.rmi.RemoteException,
                                           com.liferay.portal.SystemException,
                                           com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

deleteEntry

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

updateEntry

public static org.json.JSONObject updateEntry(long entryId,
                                              java.lang.String title,
                                              java.lang.String content,
                                              java.lang.String url,
                                              java.lang.String type,
                                              int displayDateMonth,
                                              int displayDateDay,
                                              int displayDateYear,
                                              int displayDateHour,
                                              int displayDateMinute,
                                              int expirationDateMonth,
                                              int expirationDateDay,
                                              int expirationDateYear,
                                              int expirationDateHour,
                                              int expirationDateMinute,
                                              int priority)
                                       throws java.rmi.RemoteException,
                                              com.liferay.portal.SystemException,
                                              com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException