com.liferay.portlet.calendar.service.http
Class CalEventServiceJSON

java.lang.Object
  com.liferay.portlet.calendar.service.http.CalEventServiceJSON

public class CalEventServiceJSON
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.calendar.service.CalEventServiceUtil 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.portlet.calendar.model.CalEvent, 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.portlet.calendar.service.http.CalEventJSONSerializer.

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:

CalEventServiceUtil, CalEventJSONSerializer

Constructor Summary

CalEventServiceJSON()

Method Summary

static com.liferay.portal.kernel.json.JSONObject	addEvent(java.lang.String title, java.lang.String description, int startDateMonth, int startDateDay, int startDateYear, int startDateHour, int startDateMinute, int endDateMonth, int endDateDay, int endDateYear, int durationHour, int durationMinute, boolean allDay, boolean timeZoneSensitive, java.lang.String type, boolean repeating, com.liferay.portal.kernel.cal.TZSRecurrence recurrence, java.lang.String remindBy, int firstReminder, int secondReminder, com.liferay.portal.service.ServiceContext serviceContext)
static void	deleteEvent(long eventId)
static com.liferay.portal.kernel.json.JSONObject	getEvent(long eventId)
static com.liferay.portal.kernel.json.JSONObject	updateEvent(long eventId, java.lang.String title, java.lang.String description, int startDateMonth, int startDateDay, int startDateYear, int startDateHour, int startDateMinute, int endDateMonth, int endDateDay, int endDateYear, int durationHour, int durationMinute, boolean allDay, boolean timeZoneSensitive, java.lang.String type, boolean repeating, com.liferay.portal.kernel.cal.TZSRecurrence recurrence, java.lang.String remindBy, int firstReminder, int secondReminder)

Methods inherited from class java.lang.Object

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

Constructor Detail

CalEventServiceJSON

public CalEventServiceJSON()

Method Detail

addEvent

public static com.liferay.portal.kernel.json.JSONObject addEvent(java.lang.String title,
                                                                 java.lang.String description,
                                                                 int startDateMonth,
                                                                 int startDateDay,
                                                                 int startDateYear,
                                                                 int startDateHour,
                                                                 int startDateMinute,
                                                                 int endDateMonth,
                                                                 int endDateDay,
                                                                 int endDateYear,
                                                                 int durationHour,
                                                                 int durationMinute,
                                                                 boolean allDay,
                                                                 boolean timeZoneSensitive,
                                                                 java.lang.String type,
                                                                 boolean repeating,
                                                                 com.liferay.portal.kernel.cal.TZSRecurrence recurrence,
                                                                 java.lang.String remindBy,
                                                                 int firstReminder,
                                                                 int secondReminder,
                                                                 com.liferay.portal.service.ServiceContext serviceContext)
                                                          throws com.liferay.portal.PortalException,
                                                                 com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

deleteEvent

public static void deleteEvent(long eventId)
                        throws com.liferay.portal.PortalException,
                               com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getEvent

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

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateEvent

public static com.liferay.portal.kernel.json.JSONObject updateEvent(long eventId,
                                                                    java.lang.String title,
                                                                    java.lang.String description,
                                                                    int startDateMonth,
                                                                    int startDateDay,
                                                                    int startDateYear,
                                                                    int startDateHour,
                                                                    int startDateMinute,
                                                                    int endDateMonth,
                                                                    int endDateDay,
                                                                    int endDateYear,
                                                                    int durationHour,
                                                                    int durationMinute,
                                                                    boolean allDay,
                                                                    boolean timeZoneSensitive,
                                                                    java.lang.String type,
                                                                    boolean repeating,
                                                                    com.liferay.portal.kernel.cal.TZSRecurrence recurrence,
                                                                    java.lang.String remindBy,
                                                                    int firstReminder,
                                                                    int secondReminder)
                                                             throws com.liferay.portal.PortalException,
                                                                    com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException