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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.calendar.model.impl.CalEventModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.calendar.model.impl.CalEventModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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 matching the UUID and group.
182            *
183            * @param uuid the cal event's UUID
184            * @param groupId the primary key of the group
185            * @return the matching cal event
186            * @throws PortalException if a matching cal event 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.calendar.model.impl.CalEventModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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            * Returns the Spring bean ID for this bean.
235            *
236            * @return the Spring bean ID for this bean
237            */
238            public java.lang.String getBeanIdentifier();
239    
240            /**
241            * Sets the Spring bean ID for this bean.
242            *
243            * @param beanIdentifier the Spring bean ID for this bean
244            */
245            public void setBeanIdentifier(java.lang.String beanIdentifier);
246    
247            public com.liferay.portlet.calendar.model.CalEvent addEvent(long userId,
248                    java.lang.String title, java.lang.String description,
249                    java.lang.String location, int startDateMonth, int startDateDay,
250                    int startDateYear, int startDateHour, int startDateMinute,
251                    int durationHour, int durationMinute, boolean allDay,
252                    boolean timeZoneSensitive, java.lang.String type, boolean repeating,
253                    com.liferay.portal.kernel.cal.TZSRecurrence recurrence, int remindBy,
254                    int firstReminder, int secondReminder,
255                    com.liferay.portal.service.ServiceContext serviceContext)
256                    throws com.liferay.portal.kernel.exception.PortalException,
257                            com.liferay.portal.kernel.exception.SystemException;
258    
259            /**
260            * @deprecated As of 6.2.0, replaced by {@link #addEvent(long, String,
261            String, String, int, int, int, int, int, int, int, boolean,
262            boolean, String, boolean, TZSRecurrence, int, int, int,
263            ServiceContext)}
264            */
265            public com.liferay.portlet.calendar.model.CalEvent addEvent(long userId,
266                    java.lang.String title, java.lang.String description,
267                    java.lang.String location, int startDateMonth, int startDateDay,
268                    int startDateYear, int startDateHour, int startDateMinute,
269                    int endDateMonth, int endDateDay, int endDateYear, int durationHour,
270                    int durationMinute, boolean allDay, boolean timeZoneSensitive,
271                    java.lang.String type, boolean repeating,
272                    com.liferay.portal.kernel.cal.TZSRecurrence recurrence, int remindBy,
273                    int firstReminder, int secondReminder,
274                    com.liferay.portal.service.ServiceContext serviceContext)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException;
277    
278            public void addEventResources(
279                    com.liferay.portlet.calendar.model.CalEvent event,
280                    boolean addGroupPermissions, boolean addGuestPermissions)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException;
283    
284            public void addEventResources(
285                    com.liferay.portlet.calendar.model.CalEvent event,
286                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException;
289    
290            public void addEventResources(long eventId, boolean addGroupPermissions,
291                    boolean addGuestPermissions)
292                    throws com.liferay.portal.kernel.exception.PortalException,
293                            com.liferay.portal.kernel.exception.SystemException;
294    
295            public void addEventResources(long eventId,
296                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException;
299    
300            public void checkEvents()
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException;
303    
304            public com.liferay.portlet.calendar.model.CalEvent deleteEvent(
305                    com.liferay.portlet.calendar.model.CalEvent event)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException;
308    
309            public com.liferay.portlet.calendar.model.CalEvent deleteEvent(long eventId)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException;
312    
313            public void deleteEvents(long groupId)
314                    throws com.liferay.portal.kernel.exception.PortalException,
315                            com.liferay.portal.kernel.exception.SystemException;
316    
317            public java.io.File exportEvent(long userId, long eventId)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException;
320    
321            public java.io.File exportEvents(long userId,
322                    java.util.List<com.liferay.portlet.calendar.model.CalEvent> events,
323                    java.lang.String fileName)
324                    throws com.liferay.portal.kernel.exception.PortalException,
325                            com.liferay.portal.kernel.exception.SystemException;
326    
327            public java.io.File exportGroupEvents(long userId, long groupId,
328                    java.lang.String fileName)
329                    throws com.liferay.portal.kernel.exception.PortalException,
330                            com.liferay.portal.kernel.exception.SystemException;
331    
332            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
333            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getCompanyEvents(
334                    long companyId, int start, int end)
335                    throws com.liferay.portal.kernel.exception.SystemException;
336    
337            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
338            public int getCompanyEventsCount(long companyId)
339                    throws com.liferay.portal.kernel.exception.SystemException;
340    
341            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
342            public com.liferay.portlet.calendar.model.CalEvent getEvent(long eventId)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException;
345    
346            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
347            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
348                    long groupId, java.util.Calendar cal)
349                    throws com.liferay.portal.kernel.exception.SystemException;
350    
351            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
352            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
353                    long groupId, java.util.Calendar cal, java.lang.String type)
354                    throws com.liferay.portal.kernel.exception.SystemException;
355    
356            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
357            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
358                    long groupId, java.util.Calendar cal, java.lang.String[] types)
359                    throws com.liferay.portal.kernel.exception.SystemException;
360    
361            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
362            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
363                    long groupId, java.lang.String type, int start, int end)
364                    throws com.liferay.portal.kernel.exception.SystemException;
365    
366            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
367            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
368                    long groupId, java.lang.String[] types, int start, int end)
369                    throws com.liferay.portal.kernel.exception.SystemException;
370    
371            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
372            public int getEventsCount(long groupId, java.lang.String type)
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[] types)
377                    throws com.liferay.portal.kernel.exception.SystemException;
378    
379            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
380            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getNoAssetEvents()
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> getRepeatingEvents(
385                    long groupId)
386                    throws com.liferay.portal.kernel.exception.SystemException;
387    
388            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
389            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getRepeatingEvents(
390                    long groupId, java.util.Calendar cal, java.lang.String[] types)
391                    throws com.liferay.portal.kernel.exception.SystemException;
392    
393            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
394            public boolean hasEvents(long groupId, java.util.Calendar cal)
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                    java.lang.String type)
400                    throws com.liferay.portal.kernel.exception.SystemException;
401    
402            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
403            public boolean hasEvents(long groupId, java.util.Calendar cal,
404                    java.lang.String[] types)
405                    throws com.liferay.portal.kernel.exception.SystemException;
406    
407            public void importICal4j(long userId, long groupId,
408                    java.io.InputStream inputStream)
409                    throws com.liferay.portal.kernel.exception.PortalException,
410                            com.liferay.portal.kernel.exception.SystemException;
411    
412            public void updateAsset(long userId,
413                    com.liferay.portlet.calendar.model.CalEvent event,
414                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
415                    long[] assetLinkEntryIds)
416                    throws com.liferay.portal.kernel.exception.PortalException,
417                            com.liferay.portal.kernel.exception.SystemException;
418    
419            public com.liferay.portlet.calendar.model.CalEvent updateEvent(
420                    long userId, long eventId, java.lang.String title,
421                    java.lang.String description, java.lang.String location,
422                    int startDateMonth, int startDateDay, int startDateYear,
423                    int startDateHour, int startDateMinute, int durationHour,
424                    int durationMinute, boolean allDay, boolean timeZoneSensitive,
425                    java.lang.String type, boolean repeating,
426                    com.liferay.portal.kernel.cal.TZSRecurrence recurrence, int remindBy,
427                    int firstReminder, int secondReminder,
428                    com.liferay.portal.service.ServiceContext serviceContext)
429                    throws com.liferay.portal.kernel.exception.PortalException,
430                            com.liferay.portal.kernel.exception.SystemException;
431    
432            /**
433            * @deprecated As of 6.2.0, replaced by {@link #updateEvent(long, long,
434            String, String, String, int, int, int, int, int, int, int,
435            boolean, boolean, String, boolean, TZSRecurrence, int, int,
436            int, ServiceContext)}
437            */
438            public com.liferay.portlet.calendar.model.CalEvent updateEvent(
439                    long userId, long eventId, java.lang.String title,
440                    java.lang.String description, java.lang.String location,
441                    int startDateMonth, int startDateDay, int startDateYear,
442                    int startDateHour, int startDateMinute, int endDateMonth,
443                    int endDateDay, int endDateYear, int durationHour, int durationMinute,
444                    boolean allDay, boolean timeZoneSensitive, java.lang.String type,
445                    boolean repeating,
446                    com.liferay.portal.kernel.cal.TZSRecurrence recurrence, int remindBy,
447                    int firstReminder, int secondReminder,
448                    com.liferay.portal.service.ServiceContext serviceContext)
449                    throws com.liferay.portal.kernel.exception.PortalException,
450                            com.liferay.portal.kernel.exception.SystemException;
451    }