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.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 endDateMonth, int endDateDay, int endDateYear, int durationHour,
264                    int durationMinute, boolean allDay, boolean timeZoneSensitive,
265                    java.lang.String type, boolean repeating,
266                    com.liferay.portal.kernel.cal.TZSRecurrence recurrence, int remindBy,
267                    int firstReminder, int secondReminder,
268                    com.liferay.portal.service.ServiceContext serviceContext)
269                    throws com.liferay.portal.kernel.exception.PortalException,
270                            com.liferay.portal.kernel.exception.SystemException;
271    
272            public void addEventResources(
273                    com.liferay.portlet.calendar.model.CalEvent event,
274                    boolean addGroupPermissions, boolean addGuestPermissions)
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                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException;
283    
284            public void addEventResources(long eventId, boolean addGroupPermissions,
285                    boolean addGuestPermissions)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException;
288    
289            public void addEventResources(long eventId,
290                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
291                    throws com.liferay.portal.kernel.exception.PortalException,
292                            com.liferay.portal.kernel.exception.SystemException;
293    
294            public void checkEvents()
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException;
297    
298            public void deleteEvent(com.liferay.portlet.calendar.model.CalEvent event)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException;
301    
302            public void deleteEvent(long eventId)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException;
305    
306            public void deleteEvents(long groupId)
307                    throws com.liferay.portal.kernel.exception.PortalException,
308                            com.liferay.portal.kernel.exception.SystemException;
309    
310            public java.io.File exportEvent(long userId, long eventId)
311                    throws com.liferay.portal.kernel.exception.PortalException,
312                            com.liferay.portal.kernel.exception.SystemException;
313    
314            public java.io.File exportGroupEvents(long userId, long groupId,
315                    java.lang.String fileName)
316                    throws com.liferay.portal.kernel.exception.PortalException,
317                            com.liferay.portal.kernel.exception.SystemException;
318    
319            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
320            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getCompanyEvents(
321                    long companyId, int start, int end)
322                    throws com.liferay.portal.kernel.exception.SystemException;
323    
324            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
325            public int getCompanyEventsCount(long companyId)
326                    throws com.liferay.portal.kernel.exception.SystemException;
327    
328            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
329            public com.liferay.portlet.calendar.model.CalEvent getEvent(long eventId)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException;
332    
333            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
334            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
335                    long groupId, java.util.Calendar cal)
336                    throws com.liferay.portal.kernel.exception.SystemException;
337    
338            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
339            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
340                    long groupId, java.util.Calendar cal, java.lang.String type)
341                    throws com.liferay.portal.kernel.exception.SystemException;
342    
343            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
344            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
345                    long groupId, java.util.Calendar cal, java.lang.String[] types)
346                    throws com.liferay.portal.kernel.exception.SystemException;
347    
348            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
349            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
350                    long groupId, java.lang.String type, int start, int end)
351                    throws com.liferay.portal.kernel.exception.SystemException;
352    
353            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
354            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
355                    long groupId, java.lang.String[] types, int start, int end)
356                    throws com.liferay.portal.kernel.exception.SystemException;
357    
358            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
359            public int getEventsCount(long groupId, java.lang.String type)
360                    throws com.liferay.portal.kernel.exception.SystemException;
361    
362            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
363            public int getEventsCount(long groupId, java.lang.String[] types)
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> getNoAssetEvents()
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> getRepeatingEvents(
372                    long groupId)
373                    throws com.liferay.portal.kernel.exception.SystemException;
374    
375            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
376            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getRepeatingEvents(
377                    long groupId, java.util.Calendar cal, java.lang.String[] types)
378                    throws com.liferay.portal.kernel.exception.SystemException;
379    
380            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
381            public boolean hasEvents(long groupId, java.util.Calendar cal)
382                    throws com.liferay.portal.kernel.exception.SystemException;
383    
384            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
385            public boolean hasEvents(long groupId, java.util.Calendar cal,
386                    java.lang.String type)
387                    throws com.liferay.portal.kernel.exception.SystemException;
388    
389            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
390            public boolean hasEvents(long groupId, java.util.Calendar cal,
391                    java.lang.String[] types)
392                    throws com.liferay.portal.kernel.exception.SystemException;
393    
394            public void importICal4j(long userId, long groupId,
395                    java.io.InputStream inputStream)
396                    throws com.liferay.portal.kernel.exception.PortalException,
397                            com.liferay.portal.kernel.exception.SystemException;
398    
399            public void updateAsset(long userId,
400                    com.liferay.portlet.calendar.model.CalEvent event,
401                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
402                    long[] assetLinkEntryIds)
403                    throws com.liferay.portal.kernel.exception.PortalException,
404                            com.liferay.portal.kernel.exception.SystemException;
405    
406            public com.liferay.portlet.calendar.model.CalEvent updateEvent(
407                    long userId, long eventId, java.lang.String title,
408                    java.lang.String description, java.lang.String location,
409                    int startDateMonth, int startDateDay, int startDateYear,
410                    int startDateHour, int startDateMinute, int endDateMonth,
411                    int endDateDay, int endDateYear, int durationHour, int durationMinute,
412                    boolean allDay, boolean timeZoneSensitive, java.lang.String type,
413                    boolean repeating,
414                    com.liferay.portal.kernel.cal.TZSRecurrence recurrence, int remindBy,
415                    int firstReminder, int secondReminder,
416                    com.liferay.portal.service.ServiceContext serviceContext)
417                    throws com.liferay.portal.kernel.exception.PortalException,
418                            com.liferay.portal.kernel.exception.SystemException;
419    }