001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.calendar.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    
019    /**
020     * The utility for the cal event local service. This utility wraps {@link com.liferay.portlet.calendar.service.impl.CalEventLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
021     *
022     * <p>
023     * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.calendar.service.impl.CalEventLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
024     * </p>
025     *
026     * <p>
027     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see CalEventLocalService
032     * @see com.liferay.portlet.calendar.service.base.CalEventLocalServiceBaseImpl
033     * @see com.liferay.portlet.calendar.service.impl.CalEventLocalServiceImpl
034     * @generated
035     */
036    public class CalEventLocalServiceUtil {
037            /**
038            * Adds the cal event to the database. Also notifies the appropriate model listeners.
039            *
040            * @param calEvent the cal event to add
041            * @return the cal event that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portlet.calendar.model.CalEvent addCalEvent(
045                    com.liferay.portlet.calendar.model.CalEvent calEvent)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addCalEvent(calEvent);
048            }
049    
050            /**
051            * Creates a new cal event with the primary key. Does not add the cal event to the database.
052            *
053            * @param eventId the primary key for the new cal event
054            * @return the new cal event
055            */
056            public static com.liferay.portlet.calendar.model.CalEvent createCalEvent(
057                    long eventId) {
058                    return getService().createCalEvent(eventId);
059            }
060    
061            /**
062            * Deletes the cal event with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param eventId the primary key of the cal event to delete
065            * @throws PortalException if a cal event with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteCalEvent(long eventId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteCalEvent(eventId);
072            }
073    
074            /**
075            * Deletes the cal event from the database. Also notifies the appropriate model listeners.
076            *
077            * @param calEvent the cal event to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteCalEvent(
081                    com.liferay.portlet.calendar.model.CalEvent calEvent)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteCalEvent(calEvent);
084            }
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query to search with
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public static java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException {
097                    return getService().dynamicQuery(dynamicQuery);
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query to search with
108            * @param start the lower bound of the range of model instances to return
109            * @param end the upper bound of the range of model instances to return (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public static java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException {
117                    return getService().dynamicQuery(dynamicQuery, start, end);
118            }
119    
120            /**
121            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
122            *
123            * <p>
124            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query to search with
128            * @param start the lower bound of the range of model instances to return
129            * @param end the upper bound of the range of model instances to return (not inclusive)
130            * @param orderByComparator the comparator to order the results by
131            * @return the ordered range of matching rows
132            * @throws SystemException if a system exception occurred
133            */
134            @SuppressWarnings("rawtypes")
135            public static java.util.List dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
137                    int end,
138                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
139                    throws com.liferay.portal.kernel.exception.SystemException {
140                    return getService()
141                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
142            }
143    
144            /**
145            * Counts the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query to search with
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public static long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().dynamicQueryCount(dynamicQuery);
155            }
156    
157            /**
158            * Gets the cal event with the primary key.
159            *
160            * @param eventId the primary key of the cal event to get
161            * @return the cal event
162            * @throws PortalException if a cal event with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portlet.calendar.model.CalEvent getCalEvent(
166                    long eventId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getCalEvent(eventId);
170            }
171    
172            /**
173            * Gets the cal event with the UUID and group id.
174            *
175            * @param uuid the UUID of cal event to get
176            * @param groupId the group id of the cal event to get
177            * @return the cal event
178            * @throws PortalException if a cal event with the UUID and group id could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.calendar.model.CalEvent getCalEventByUuidAndGroupId(
182                    java.lang.String uuid, long groupId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getCalEventByUuidAndGroupId(uuid, groupId);
186            }
187    
188            /**
189            * Gets a range of all the cal events.
190            *
191            * <p>
192            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
193            * </p>
194            *
195            * @param start the lower bound of the range of cal events to return
196            * @param end the upper bound of the range of cal events to return (not inclusive)
197            * @return the range of cal events
198            * @throws SystemException if a system exception occurred
199            */
200            public static java.util.List<com.liferay.portlet.calendar.model.CalEvent> getCalEvents(
201                    int start, int end)
202                    throws com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getCalEvents(start, end);
204            }
205    
206            /**
207            * Gets the number of cal events.
208            *
209            * @return the number of cal events
210            * @throws SystemException if a system exception occurred
211            */
212            public static int getCalEventsCount()
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getCalEventsCount();
215            }
216    
217            /**
218            * Updates the cal event in the database. Also notifies the appropriate model listeners.
219            *
220            * @param calEvent the cal event to update
221            * @return the cal event that was updated
222            * @throws SystemException if a system exception occurred
223            */
224            public static com.liferay.portlet.calendar.model.CalEvent updateCalEvent(
225                    com.liferay.portlet.calendar.model.CalEvent calEvent)
226                    throws com.liferay.portal.kernel.exception.SystemException {
227                    return getService().updateCalEvent(calEvent);
228            }
229    
230            /**
231            * Updates the cal event in the database. Also notifies the appropriate model listeners.
232            *
233            * @param calEvent the cal event to update
234            * @param merge whether to merge the cal event with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
235            * @return the cal event that was updated
236            * @throws SystemException if a system exception occurred
237            */
238            public static com.liferay.portlet.calendar.model.CalEvent updateCalEvent(
239                    com.liferay.portlet.calendar.model.CalEvent calEvent, boolean merge)
240                    throws com.liferay.portal.kernel.exception.SystemException {
241                    return getService().updateCalEvent(calEvent, merge);
242            }
243    
244            public static com.liferay.portlet.calendar.model.CalEvent addEvent(
245                    long userId, java.lang.String title, java.lang.String description,
246                    int startDateMonth, int startDateDay, int startDateYear,
247                    int startDateHour, int startDateMinute, int endDateMonth,
248                    int endDateDay, int endDateYear, int durationHour, int durationMinute,
249                    boolean allDay, boolean timeZoneSensitive, java.lang.String type,
250                    boolean repeating,
251                    com.liferay.portal.kernel.cal.TZSRecurrence recurrence, int remindBy,
252                    int firstReminder, int secondReminder,
253                    com.liferay.portal.service.ServiceContext serviceContext)
254                    throws com.liferay.portal.kernel.exception.PortalException,
255                            com.liferay.portal.kernel.exception.SystemException {
256                    return getService()
257                                       .addEvent(userId, title, description, startDateMonth,
258                            startDateDay, startDateYear, startDateHour, startDateMinute,
259                            endDateMonth, endDateDay, endDateYear, durationHour,
260                            durationMinute, allDay, timeZoneSensitive, type, repeating,
261                            recurrence, remindBy, firstReminder, secondReminder, serviceContext);
262            }
263    
264            public static void addEventResources(
265                    com.liferay.portlet.calendar.model.CalEvent event,
266                    boolean addCommunityPermissions, boolean addGuestPermissions)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException {
269                    getService()
270                            .addEventResources(event, addCommunityPermissions,
271                            addGuestPermissions);
272            }
273    
274            public static void addEventResources(
275                    com.liferay.portlet.calendar.model.CalEvent event,
276                    java.lang.String[] communityPermissions,
277                    java.lang.String[] guestPermissions)
278                    throws com.liferay.portal.kernel.exception.PortalException,
279                            com.liferay.portal.kernel.exception.SystemException {
280                    getService()
281                            .addEventResources(event, communityPermissions, guestPermissions);
282            }
283    
284            public static void addEventResources(long eventId,
285                    boolean addCommunityPermissions, boolean addGuestPermissions)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException {
288                    getService()
289                            .addEventResources(eventId, addCommunityPermissions,
290                            addGuestPermissions);
291            }
292    
293            public static void addEventResources(long eventId,
294                    java.lang.String[] communityPermissions,
295                    java.lang.String[] guestPermissions)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException {
298                    getService()
299                            .addEventResources(eventId, communityPermissions, guestPermissions);
300            }
301    
302            public static void checkEvents()
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    getService().checkEvents();
306            }
307    
308            public static void deleteEvent(
309                    com.liferay.portlet.calendar.model.CalEvent event)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException {
312                    getService().deleteEvent(event);
313            }
314    
315            public static void deleteEvent(long eventId)
316                    throws com.liferay.portal.kernel.exception.PortalException,
317                            com.liferay.portal.kernel.exception.SystemException {
318                    getService().deleteEvent(eventId);
319            }
320    
321            public static void deleteEvents(long groupId)
322                    throws com.liferay.portal.kernel.exception.PortalException,
323                            com.liferay.portal.kernel.exception.SystemException {
324                    getService().deleteEvents(groupId);
325            }
326    
327            public static java.io.File exportEvent(long userId, long eventId)
328                    throws com.liferay.portal.kernel.exception.PortalException,
329                            com.liferay.portal.kernel.exception.SystemException {
330                    return getService().exportEvent(userId, eventId);
331            }
332    
333            public static java.io.File exportGroupEvents(long userId, long groupId,
334                    java.lang.String fileName)
335                    throws com.liferay.portal.kernel.exception.PortalException,
336                            com.liferay.portal.kernel.exception.SystemException {
337                    return getService().exportGroupEvents(userId, groupId, fileName);
338            }
339    
340            public static java.util.List<com.liferay.portlet.calendar.model.CalEvent> getCompanyEvents(
341                    long companyId, int start, int end)
342                    throws com.liferay.portal.kernel.exception.SystemException {
343                    return getService().getCompanyEvents(companyId, start, end);
344            }
345    
346            public static int getCompanyEventsCount(long companyId)
347                    throws com.liferay.portal.kernel.exception.SystemException {
348                    return getService().getCompanyEventsCount(companyId);
349            }
350    
351            public static com.liferay.portlet.calendar.model.CalEvent getEvent(
352                    long eventId)
353                    throws com.liferay.portal.kernel.exception.PortalException,
354                            com.liferay.portal.kernel.exception.SystemException {
355                    return getService().getEvent(eventId);
356            }
357    
358            public static java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
359                    long groupId, java.util.Calendar cal)
360                    throws com.liferay.portal.kernel.exception.SystemException {
361                    return getService().getEvents(groupId, cal);
362            }
363    
364            public static java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
365                    long groupId, java.util.Calendar cal, java.lang.String type)
366                    throws com.liferay.portal.kernel.exception.SystemException {
367                    return getService().getEvents(groupId, cal, type);
368            }
369    
370            public static java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
371                    long groupId, java.lang.String type, int start, int end)
372                    throws com.liferay.portal.kernel.exception.SystemException {
373                    return getService().getEvents(groupId, type, start, end);
374            }
375    
376            public static int getEventsCount(long groupId, java.lang.String type)
377                    throws com.liferay.portal.kernel.exception.SystemException {
378                    return getService().getEventsCount(groupId, type);
379            }
380    
381            public static java.util.List<com.liferay.portlet.calendar.model.CalEvent> getNoAssetEvents()
382                    throws com.liferay.portal.kernel.exception.SystemException {
383                    return getService().getNoAssetEvents();
384            }
385    
386            public static java.util.List<com.liferay.portlet.calendar.model.CalEvent> getRepeatingEvents(
387                    long groupId)
388                    throws com.liferay.portal.kernel.exception.SystemException {
389                    return getService().getRepeatingEvents(groupId);
390            }
391    
392            public static boolean hasEvents(long groupId, java.util.Calendar cal)
393                    throws com.liferay.portal.kernel.exception.SystemException {
394                    return getService().hasEvents(groupId, cal);
395            }
396    
397            public static boolean hasEvents(long groupId, java.util.Calendar cal,
398                    java.lang.String type)
399                    throws com.liferay.portal.kernel.exception.SystemException {
400                    return getService().hasEvents(groupId, cal, type);
401            }
402    
403            public static void importICal4j(long userId, long groupId, java.io.File file)
404                    throws com.liferay.portal.kernel.exception.PortalException,
405                            com.liferay.portal.kernel.exception.SystemException {
406                    getService().importICal4j(userId, groupId, file);
407            }
408    
409            public static void updateAsset(long userId,
410                    com.liferay.portlet.calendar.model.CalEvent event,
411                    long[] assetCategoryIds, java.lang.String[] assetTagNames)
412                    throws com.liferay.portal.kernel.exception.PortalException,
413                            com.liferay.portal.kernel.exception.SystemException {
414                    getService().updateAsset(userId, event, assetCategoryIds, assetTagNames);
415            }
416    
417            public static com.liferay.portlet.calendar.model.CalEvent updateEvent(
418                    long userId, long eventId, java.lang.String title,
419                    java.lang.String description, int startDateMonth, int startDateDay,
420                    int startDateYear, int startDateHour, int startDateMinute,
421                    int endDateMonth, int endDateDay, int endDateYear, int durationHour,
422                    int durationMinute, boolean allDay, boolean timeZoneSensitive,
423                    java.lang.String type, boolean repeating,
424                    com.liferay.portal.kernel.cal.TZSRecurrence recurrence, int remindBy,
425                    int firstReminder, int secondReminder,
426                    com.liferay.portal.service.ServiceContext serviceContext)
427                    throws com.liferay.portal.kernel.exception.PortalException,
428                            com.liferay.portal.kernel.exception.SystemException {
429                    return getService()
430                                       .updateEvent(userId, eventId, title, description,
431                            startDateMonth, startDateDay, startDateYear, startDateHour,
432                            startDateMinute, endDateMonth, endDateDay, endDateYear,
433                            durationHour, durationMinute, allDay, timeZoneSensitive, type,
434                            repeating, recurrence, remindBy, firstReminder, secondReminder,
435                            serviceContext);
436            }
437    
438            public static CalEventLocalService getService() {
439                    if (_service == null) {
440                            _service = (CalEventLocalService)PortalBeanLocatorUtil.locate(CalEventLocalService.class.getName());
441                    }
442    
443                    return _service;
444            }
445    
446            public void setService(CalEventLocalService service) {
447                    _service = service;
448            }
449    
450            private static CalEventLocalService _service;
451    }