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