001    /**
002     * Copyright (c) 2000-2012 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 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. 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 {@link #addEvent(long, String, String, String, int, int, int,
261            int, int, int, int, boolean, boolean, String, boolean,
262            TZSRecurrence, int, int, int, ServiceContext)}
263            */
264            public com.liferay.portlet.calendar.model.CalEvent addEvent(long userId,
265                    java.lang.String title, java.lang.String description,
266                    java.lang.String location, int startDateMonth, int startDateDay,
267                    int startDateYear, int startDateHour, int startDateMinute,
268                    int endDateMonth, int endDateDay, int endDateYear, int durationHour,
269                    int durationMinute, boolean allDay, boolean timeZoneSensitive,
270                    java.lang.String type, boolean repeating,
271                    com.liferay.portal.kernel.cal.TZSRecurrence recurrence, int remindBy,
272                    int firstReminder, int secondReminder,
273                    com.liferay.portal.service.ServiceContext serviceContext)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException;
276    
277            public void addEventResources(
278                    com.liferay.portlet.calendar.model.CalEvent event,
279                    boolean addGroupPermissions, boolean addGuestPermissions)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException;
282    
283            public void addEventResources(
284                    com.liferay.portlet.calendar.model.CalEvent event,
285                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException;
288    
289            public void addEventResources(long eventId, boolean addGroupPermissions,
290                    boolean addGuestPermissions)
291                    throws com.liferay.portal.kernel.exception.PortalException,
292                            com.liferay.portal.kernel.exception.SystemException;
293    
294            public void addEventResources(long eventId,
295                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException;
298    
299            public void checkEvents()
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException;
302    
303            public com.liferay.portlet.calendar.model.CalEvent deleteEvent(
304                    com.liferay.portlet.calendar.model.CalEvent event)
305                    throws com.liferay.portal.kernel.exception.PortalException,
306                            com.liferay.portal.kernel.exception.SystemException;
307    
308            public com.liferay.portlet.calendar.model.CalEvent deleteEvent(long eventId)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException;
311    
312            public void deleteEvents(long groupId)
313                    throws com.liferay.portal.kernel.exception.PortalException,
314                            com.liferay.portal.kernel.exception.SystemException;
315    
316            public java.io.File exportEvent(long userId, long eventId)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException;
319    
320            public java.io.File exportEvents(long userId,
321                    java.util.List<com.liferay.portlet.calendar.model.CalEvent> events,
322                    java.lang.String fileName)
323                    throws com.liferay.portal.kernel.exception.PortalException,
324                            com.liferay.portal.kernel.exception.SystemException;
325    
326            public java.io.File exportGroupEvents(long userId, long groupId,
327                    java.lang.String fileName)
328                    throws com.liferay.portal.kernel.exception.PortalException,
329                            com.liferay.portal.kernel.exception.SystemException;
330    
331            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
332            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getCompanyEvents(
333                    long companyId, int start, int end)
334                    throws com.liferay.portal.kernel.exception.SystemException;
335    
336            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
337            public int getCompanyEventsCount(long companyId)
338                    throws com.liferay.portal.kernel.exception.SystemException;
339    
340            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
341            public com.liferay.portlet.calendar.model.CalEvent getEvent(long eventId)
342                    throws com.liferay.portal.kernel.exception.PortalException,
343                            com.liferay.portal.kernel.exception.SystemException;
344    
345            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
346            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
347                    long groupId, java.util.Calendar cal)
348                    throws 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, java.lang.String type)
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[] types)
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.lang.String type, int start, int end)
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[] types, int start, int end)
368                    throws com.liferay.portal.kernel.exception.SystemException;
369    
370            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
371            public int getEventsCount(long groupId, java.lang.String type)
372                    throws com.liferay.portal.kernel.exception.SystemException;
373    
374            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
375            public int getEventsCount(long groupId, java.lang.String[] types)
376                    throws com.liferay.portal.kernel.exception.SystemException;
377    
378            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
379            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getNoAssetEvents()
380                    throws com.liferay.portal.kernel.exception.SystemException;
381    
382            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
383            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getRepeatingEvents(
384                    long groupId)
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, java.util.Calendar cal, java.lang.String[] types)
390                    throws com.liferay.portal.kernel.exception.SystemException;
391    
392            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
393            public boolean hasEvents(long groupId, java.util.Calendar cal)
394                    throws com.liferay.portal.kernel.exception.SystemException;
395    
396            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
397            public boolean hasEvents(long groupId, java.util.Calendar cal,
398                    java.lang.String type)
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[] types)
404                    throws com.liferay.portal.kernel.exception.SystemException;
405    
406            public void importICal4j(long userId, long groupId,
407                    java.io.InputStream inputStream)
408                    throws com.liferay.portal.kernel.exception.PortalException,
409                            com.liferay.portal.kernel.exception.SystemException;
410    
411            public void updateAsset(long userId,
412                    com.liferay.portlet.calendar.model.CalEvent event,
413                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
414                    long[] assetLinkEntryIds)
415                    throws com.liferay.portal.kernel.exception.PortalException,
416                            com.liferay.portal.kernel.exception.SystemException;
417    
418            public com.liferay.portlet.calendar.model.CalEvent updateEvent(
419                    long userId, long eventId, java.lang.String title,
420                    java.lang.String description, java.lang.String location,
421                    int startDateMonth, int startDateDay, int startDateYear,
422                    int startDateHour, int startDateMinute, int durationHour,
423                    int durationMinute, boolean allDay, boolean timeZoneSensitive,
424                    java.lang.String type, boolean repeating,
425                    com.liferay.portal.kernel.cal.TZSRecurrence recurrence, int remindBy,
426                    int firstReminder, int secondReminder,
427                    com.liferay.portal.service.ServiceContext serviceContext)
428                    throws com.liferay.portal.kernel.exception.PortalException,
429                            com.liferay.portal.kernel.exception.SystemException;
430    
431            /**
432            * @deprecated {@link #updateEvent(long, long, String, String, String, int,
433            int, int, int, int, int, int, boolean, boolean, String,
434            boolean, TZSRecurrence, int, int, int, ServiceContext)}
435            */
436            public com.liferay.portlet.calendar.model.CalEvent updateEvent(
437                    long userId, long eventId, java.lang.String title,
438                    java.lang.String description, java.lang.String location,
439                    int startDateMonth, int startDateDay, int startDateYear,
440                    int startDateHour, int startDateMinute, int endDateMonth,
441                    int endDateDay, int endDateYear, int durationHour, int durationMinute,
442                    boolean allDay, boolean timeZoneSensitive, java.lang.String type,
443                    boolean repeating,
444                    com.liferay.portal.kernel.cal.TZSRecurrence recurrence, int remindBy,
445                    int firstReminder, int secondReminder,
446                    com.liferay.portal.service.ServiceContext serviceContext)
447                    throws com.liferay.portal.kernel.exception.PortalException,
448                            com.liferay.portal.kernel.exception.SystemException;
449    }