001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portlet.calendar.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.ReferenceRegistry;
019    
020    /**
021     * 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.
022     *
023     * <p>
024     * 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.
025     * </p>
026     *
027     * @author Brian Wing Shun Chan
028     * @see CalEventLocalService
029     * @see com.liferay.portlet.calendar.service.base.CalEventLocalServiceBaseImpl
030     * @see com.liferay.portlet.calendar.service.impl.CalEventLocalServiceImpl
031     * @generated
032     */
033    public class CalEventLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * 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.
038             */
039    
040            /**
041            * Adds the cal event to the database. Also notifies the appropriate model listeners.
042            *
043            * @param calEvent the cal event
044            * @return the cal event that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.calendar.model.CalEvent addCalEvent(
048                    com.liferay.portlet.calendar.model.CalEvent calEvent)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addCalEvent(calEvent);
051            }
052    
053            /**
054            * Creates a new cal event with the primary key. Does not add the cal event to the database.
055            *
056            * @param eventId the primary key for the new cal event
057            * @return the new cal event
058            */
059            public static com.liferay.portlet.calendar.model.CalEvent createCalEvent(
060                    long eventId) {
061                    return getService().createCalEvent(eventId);
062            }
063    
064            /**
065            * Deletes the cal event with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param eventId the primary key of the cal event
068            * @return the cal event that was removed
069            * @throws PortalException if a cal event with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portlet.calendar.model.CalEvent deleteCalEvent(
073                    long eventId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteCalEvent(eventId);
077            }
078    
079            /**
080            * Deletes the cal event from the database. Also notifies the appropriate model listeners.
081            *
082            * @param calEvent the cal event
083            * @return the cal event that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.calendar.model.CalEvent deleteCalEvent(
087                    com.liferay.portlet.calendar.model.CalEvent calEvent)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteCalEvent(calEvent);
090            }
091    
092            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
093                    return getService().dynamicQuery();
094            }
095    
096            /**
097            * Performs a dynamic query on the database and returns the matching rows.
098            *
099            * @param dynamicQuery the dynamic query
100            * @return the matching rows
101            * @throws SystemException if a system exception occurred
102            */
103            @SuppressWarnings("rawtypes")
104            public static java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException {
107                    return getService().dynamicQuery(dynamicQuery);
108            }
109    
110            /**
111            * Performs a dynamic query on the database and returns a range of the matching rows.
112            *
113            * <p>
114            * 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.
115            * </p>
116            *
117            * @param dynamicQuery the dynamic query
118            * @param start the lower bound of the range of model instances
119            * @param end the upper bound of the range of model instances (not inclusive)
120            * @return the range of matching rows
121            * @throws SystemException if a system exception occurred
122            */
123            @SuppressWarnings("rawtypes")
124            public static java.util.List dynamicQuery(
125                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
126                    int end) throws com.liferay.portal.kernel.exception.SystemException {
127                    return getService().dynamicQuery(dynamicQuery, start, end);
128            }
129    
130            /**
131            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
132            *
133            * <p>
134            * 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.
135            * </p>
136            *
137            * @param dynamicQuery the dynamic query
138            * @param start the lower bound of the range of model instances
139            * @param end the upper bound of the range of model instances (not inclusive)
140            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
141            * @return the ordered range of matching rows
142            * @throws SystemException if a system exception occurred
143            */
144            @SuppressWarnings("rawtypes")
145            public static java.util.List dynamicQuery(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
147                    int end,
148                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
149                    throws com.liferay.portal.kernel.exception.SystemException {
150                    return getService()
151                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
152            }
153    
154            /**
155            * Returns the number of rows that match the dynamic query.
156            *
157            * @param dynamicQuery the dynamic query
158            * @return the number of rows that match the dynamic query
159            * @throws SystemException if a system exception occurred
160            */
161            public static long dynamicQueryCount(
162                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().dynamicQueryCount(dynamicQuery);
165            }
166    
167            public static com.liferay.portlet.calendar.model.CalEvent fetchCalEvent(
168                    long eventId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchCalEvent(eventId);
171            }
172    
173            /**
174            * Returns the cal event with the primary key.
175            *
176            * @param eventId the primary key of the cal event
177            * @return the cal event
178            * @throws PortalException if a cal event with the primary key could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.calendar.model.CalEvent getCalEvent(
182                    long eventId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getCalEvent(eventId);
186            }
187    
188            public static com.liferay.portal.model.PersistedModel getPersistedModel(
189                    java.io.Serializable primaryKeyObj)
190                    throws com.liferay.portal.kernel.exception.PortalException,
191                            com.liferay.portal.kernel.exception.SystemException {
192                    return getService().getPersistedModel(primaryKeyObj);
193            }
194    
195            /**
196            * Returns the cal event with the UUID in the group.
197            *
198            * @param uuid the UUID of cal event
199            * @param groupId the group id of the cal event
200            * @return the cal event
201            * @throws PortalException if a cal event with the UUID in the group could not be found
202            * @throws SystemException if a system exception occurred
203            */
204            public static com.liferay.portlet.calendar.model.CalEvent getCalEventByUuidAndGroupId(
205                    java.lang.String uuid, long groupId)
206                    throws com.liferay.portal.kernel.exception.PortalException,
207                            com.liferay.portal.kernel.exception.SystemException {
208                    return getService().getCalEventByUuidAndGroupId(uuid, groupId);
209            }
210    
211            /**
212            * Returns a range of all the cal events.
213            *
214            * <p>
215            * 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.
216            * </p>
217            *
218            * @param start the lower bound of the range of cal events
219            * @param end the upper bound of the range of cal events (not inclusive)
220            * @return the range of cal events
221            * @throws SystemException if a system exception occurred
222            */
223            public static java.util.List<com.liferay.portlet.calendar.model.CalEvent> getCalEvents(
224                    int start, int end)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().getCalEvents(start, end);
227            }
228    
229            /**
230            * Returns the number of cal events.
231            *
232            * @return the number of cal events
233            * @throws SystemException if a system exception occurred
234            */
235            public static int getCalEventsCount()
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().getCalEventsCount();
238            }
239    
240            /**
241            * Updates the cal event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
242            *
243            * @param calEvent the cal event
244            * @return the cal event that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portlet.calendar.model.CalEvent updateCalEvent(
248                    com.liferay.portlet.calendar.model.CalEvent calEvent)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updateCalEvent(calEvent);
251            }
252    
253            /**
254            * Updates the cal event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
255            *
256            * @param calEvent the cal event
257            * @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.
258            * @return the cal event that was updated
259            * @throws SystemException if a system exception occurred
260            */
261            public static com.liferay.portlet.calendar.model.CalEvent updateCalEvent(
262                    com.liferay.portlet.calendar.model.CalEvent calEvent, boolean merge)
263                    throws com.liferay.portal.kernel.exception.SystemException {
264                    return getService().updateCalEvent(calEvent, merge);
265            }
266    
267            /**
268            * Returns the Spring bean ID for this bean.
269            *
270            * @return the Spring bean ID for this bean
271            */
272            public static java.lang.String getBeanIdentifier() {
273                    return getService().getBeanIdentifier();
274            }
275    
276            /**
277            * Sets the Spring bean ID for this bean.
278            *
279            * @param beanIdentifier the Spring bean ID for this bean
280            */
281            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
282                    getService().setBeanIdentifier(beanIdentifier);
283            }
284    
285            public static com.liferay.portlet.calendar.model.CalEvent addEvent(
286                    long userId, java.lang.String title, java.lang.String description,
287                    java.lang.String location, int startDateMonth, int startDateDay,
288                    int startDateYear, int startDateHour, int startDateMinute,
289                    int endDateMonth, int endDateDay, int endDateYear, int durationHour,
290                    int durationMinute, boolean allDay, boolean timeZoneSensitive,
291                    java.lang.String type, boolean repeating,
292                    com.liferay.portal.kernel.cal.TZSRecurrence recurrence, int remindBy,
293                    int firstReminder, int secondReminder,
294                    com.liferay.portal.service.ServiceContext serviceContext)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException {
297                    return getService()
298                                       .addEvent(userId, title, description, location,
299                            startDateMonth, startDateDay, startDateYear, startDateHour,
300                            startDateMinute, endDateMonth, endDateDay, endDateYear,
301                            durationHour, durationMinute, allDay, timeZoneSensitive, type,
302                            repeating, recurrence, remindBy, firstReminder, secondReminder,
303                            serviceContext);
304            }
305    
306            public static void addEventResources(
307                    com.liferay.portlet.calendar.model.CalEvent event,
308                    boolean addGroupPermissions, boolean addGuestPermissions)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException {
311                    getService()
312                            .addEventResources(event, addGroupPermissions, addGuestPermissions);
313            }
314    
315            public static void addEventResources(
316                    com.liferay.portlet.calendar.model.CalEvent event,
317                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException {
320                    getService().addEventResources(event, groupPermissions, guestPermissions);
321            }
322    
323            public static void addEventResources(long eventId,
324                    boolean addGroupPermissions, boolean addGuestPermissions)
325                    throws com.liferay.portal.kernel.exception.PortalException,
326                            com.liferay.portal.kernel.exception.SystemException {
327                    getService()
328                            .addEventResources(eventId, addGroupPermissions, addGuestPermissions);
329            }
330    
331            public static void addEventResources(long eventId,
332                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
333                    throws com.liferay.portal.kernel.exception.PortalException,
334                            com.liferay.portal.kernel.exception.SystemException {
335                    getService()
336                            .addEventResources(eventId, groupPermissions, guestPermissions);
337            }
338    
339            public static void checkEvents()
340                    throws com.liferay.portal.kernel.exception.PortalException,
341                            com.liferay.portal.kernel.exception.SystemException {
342                    getService().checkEvents();
343            }
344    
345            public static void deleteEvent(
346                    com.liferay.portlet.calendar.model.CalEvent event)
347                    throws com.liferay.portal.kernel.exception.PortalException,
348                            com.liferay.portal.kernel.exception.SystemException {
349                    getService().deleteEvent(event);
350            }
351    
352            public static void deleteEvent(long eventId)
353                    throws com.liferay.portal.kernel.exception.PortalException,
354                            com.liferay.portal.kernel.exception.SystemException {
355                    getService().deleteEvent(eventId);
356            }
357    
358            public static void deleteEvents(long groupId)
359                    throws com.liferay.portal.kernel.exception.PortalException,
360                            com.liferay.portal.kernel.exception.SystemException {
361                    getService().deleteEvents(groupId);
362            }
363    
364            public static java.io.File exportEvent(long userId, long eventId)
365                    throws com.liferay.portal.kernel.exception.PortalException,
366                            com.liferay.portal.kernel.exception.SystemException {
367                    return getService().exportEvent(userId, eventId);
368            }
369    
370            public static java.io.File exportGroupEvents(long userId, long groupId,
371                    java.lang.String fileName)
372                    throws com.liferay.portal.kernel.exception.PortalException,
373                            com.liferay.portal.kernel.exception.SystemException {
374                    return getService().exportGroupEvents(userId, groupId, fileName);
375            }
376    
377            public static java.util.List<com.liferay.portlet.calendar.model.CalEvent> getCompanyEvents(
378                    long companyId, int start, int end)
379                    throws com.liferay.portal.kernel.exception.SystemException {
380                    return getService().getCompanyEvents(companyId, start, end);
381            }
382    
383            public static int getCompanyEventsCount(long companyId)
384                    throws com.liferay.portal.kernel.exception.SystemException {
385                    return getService().getCompanyEventsCount(companyId);
386            }
387    
388            public static com.liferay.portlet.calendar.model.CalEvent getEvent(
389                    long eventId)
390                    throws com.liferay.portal.kernel.exception.PortalException,
391                            com.liferay.portal.kernel.exception.SystemException {
392                    return getService().getEvent(eventId);
393            }
394    
395            public static java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
396                    long groupId, java.util.Calendar cal)
397                    throws com.liferay.portal.kernel.exception.SystemException {
398                    return getService().getEvents(groupId, cal);
399            }
400    
401            public static java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
402                    long groupId, java.util.Calendar cal, java.lang.String type)
403                    throws com.liferay.portal.kernel.exception.SystemException {
404                    return getService().getEvents(groupId, cal, type);
405            }
406    
407            public static java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
408                    long groupId, java.util.Calendar cal, java.lang.String[] types)
409                    throws com.liferay.portal.kernel.exception.SystemException {
410                    return getService().getEvents(groupId, cal, types);
411            }
412    
413            public static java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
414                    long groupId, java.lang.String type, int start, int end)
415                    throws com.liferay.portal.kernel.exception.SystemException {
416                    return getService().getEvents(groupId, type, start, end);
417            }
418    
419            public static java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
420                    long groupId, java.lang.String[] types, int start, int end)
421                    throws com.liferay.portal.kernel.exception.SystemException {
422                    return getService().getEvents(groupId, types, start, end);
423            }
424    
425            public static int getEventsCount(long groupId, java.lang.String type)
426                    throws com.liferay.portal.kernel.exception.SystemException {
427                    return getService().getEventsCount(groupId, type);
428            }
429    
430            public static int getEventsCount(long groupId, java.lang.String[] types)
431                    throws com.liferay.portal.kernel.exception.SystemException {
432                    return getService().getEventsCount(groupId, types);
433            }
434    
435            public static java.util.List<com.liferay.portlet.calendar.model.CalEvent> getNoAssetEvents()
436                    throws com.liferay.portal.kernel.exception.SystemException {
437                    return getService().getNoAssetEvents();
438            }
439    
440            public static java.util.List<com.liferay.portlet.calendar.model.CalEvent> getRepeatingEvents(
441                    long groupId)
442                    throws com.liferay.portal.kernel.exception.SystemException {
443                    return getService().getRepeatingEvents(groupId);
444            }
445    
446            public static java.util.List<com.liferay.portlet.calendar.model.CalEvent> getRepeatingEvents(
447                    long groupId, java.util.Calendar cal, java.lang.String[] types)
448                    throws com.liferay.portal.kernel.exception.SystemException {
449                    return getService().getRepeatingEvents(groupId, cal, types);
450            }
451    
452            public static boolean hasEvents(long groupId, java.util.Calendar cal)
453                    throws com.liferay.portal.kernel.exception.SystemException {
454                    return getService().hasEvents(groupId, cal);
455            }
456    
457            public static boolean hasEvents(long groupId, java.util.Calendar cal,
458                    java.lang.String type)
459                    throws com.liferay.portal.kernel.exception.SystemException {
460                    return getService().hasEvents(groupId, cal, type);
461            }
462    
463            public static boolean hasEvents(long groupId, java.util.Calendar cal,
464                    java.lang.String[] types)
465                    throws com.liferay.portal.kernel.exception.SystemException {
466                    return getService().hasEvents(groupId, cal, types);
467            }
468    
469            public static void importICal4j(long userId, long groupId,
470                    java.io.InputStream inputStream)
471                    throws com.liferay.portal.kernel.exception.PortalException,
472                            com.liferay.portal.kernel.exception.SystemException {
473                    getService().importICal4j(userId, groupId, inputStream);
474            }
475    
476            public static void updateAsset(long userId,
477                    com.liferay.portlet.calendar.model.CalEvent event,
478                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
479                    long[] assetLinkEntryIds)
480                    throws com.liferay.portal.kernel.exception.PortalException,
481                            com.liferay.portal.kernel.exception.SystemException {
482                    getService()
483                            .updateAsset(userId, event, assetCategoryIds, assetTagNames,
484                            assetLinkEntryIds);
485            }
486    
487            public static com.liferay.portlet.calendar.model.CalEvent updateEvent(
488                    long userId, long eventId, java.lang.String title,
489                    java.lang.String description, java.lang.String location,
490                    int startDateMonth, int startDateDay, int startDateYear,
491                    int startDateHour, int startDateMinute, int endDateMonth,
492                    int endDateDay, int endDateYear, int durationHour, int durationMinute,
493                    boolean allDay, boolean timeZoneSensitive, java.lang.String type,
494                    boolean repeating,
495                    com.liferay.portal.kernel.cal.TZSRecurrence recurrence, int remindBy,
496                    int firstReminder, int secondReminder,
497                    com.liferay.portal.service.ServiceContext serviceContext)
498                    throws com.liferay.portal.kernel.exception.PortalException,
499                            com.liferay.portal.kernel.exception.SystemException {
500                    return getService()
501                                       .updateEvent(userId, eventId, title, description, location,
502                            startDateMonth, startDateDay, startDateYear, startDateHour,
503                            startDateMinute, endDateMonth, endDateDay, endDateYear,
504                            durationHour, durationMinute, allDay, timeZoneSensitive, type,
505                            repeating, recurrence, remindBy, firstReminder, secondReminder,
506                            serviceContext);
507            }
508    
509            public static CalEventLocalService getService() {
510                    if (_service == null) {
511                            _service = (CalEventLocalService)PortalBeanLocatorUtil.locate(CalEventLocalService.class.getName());
512    
513                            ReferenceRegistry.registerReference(CalEventLocalServiceUtil.class,
514                                    "_service");
515                    }
516    
517                    return _service;
518            }
519    
520            /**
521             * @deprecated
522             */
523            public void setService(CalEventLocalService service) {
524            }
525    
526            private static CalEventLocalService _service;
527    }