001    /**
002     * Copyright (c) 2000-2011 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.PersistedModelLocalService;
023    
024    /**
025     * The interface for the cal event local service.
026     *
027     * <p>
028     * 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.
029     * </p>
030     *
031     * @author Brian Wing Shun Chan
032     * @see CalEventLocalServiceUtil
033     * @see com.liferay.portlet.calendar.service.base.CalEventLocalServiceBaseImpl
034     * @see com.liferay.portlet.calendar.service.impl.CalEventLocalServiceImpl
035     * @generated
036     */
037    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
038            PortalException.class, SystemException.class})
039    public interface CalEventLocalService extends PersistedModelLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * 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.
044             */
045    
046            /**
047            * Adds the cal event to the database. Also notifies the appropriate model listeners.
048            *
049            * @param calEvent the cal event
050            * @return the cal event that was added
051            * @throws SystemException if a system exception occurred
052            */
053            public com.liferay.portlet.calendar.model.CalEvent addCalEvent(
054                    com.liferay.portlet.calendar.model.CalEvent calEvent)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            /**
058            * Creates a new cal event with the primary key. Does not add the cal event to the database.
059            *
060            * @param eventId the primary key for the new cal event
061            * @return the new cal event
062            */
063            public com.liferay.portlet.calendar.model.CalEvent createCalEvent(
064                    long eventId);
065    
066            /**
067            * Deletes the cal event with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param eventId the primary key of the cal event
070            * @throws PortalException if a cal event with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public void deleteCalEvent(long eventId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            /**
078            * Deletes the cal event from the database. Also notifies the appropriate model listeners.
079            *
080            * @param calEvent the cal event
081            * @throws SystemException if a system exception occurred
082            */
083            public void deleteCalEvent(
084                    com.liferay.portlet.calendar.model.CalEvent calEvent)
085                    throws com.liferay.portal.kernel.exception.SystemException;
086    
087            /**
088            * Performs a dynamic query on the database and returns the matching rows.
089            *
090            * @param dynamicQuery the dynamic query
091            * @return the matching rows
092            * @throws SystemException if a system exception occurred
093            */
094            @SuppressWarnings("rawtypes")
095            public java.util.List dynamicQuery(
096                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
097                    throws com.liferay.portal.kernel.exception.SystemException;
098    
099            /**
100            * Performs a dynamic query on the database and returns a range of the matching rows.
101            *
102            * <p>
103            * 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.
104            * </p>
105            *
106            * @param dynamicQuery the dynamic query
107            * @param start the lower bound of the range of model instances
108            * @param end the upper bound of the range of model instances (not inclusive)
109            * @return the range of matching rows
110            * @throws SystemException if a system exception occurred
111            */
112            @SuppressWarnings("rawtypes")
113            public java.util.List dynamicQuery(
114                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
115                    int end) throws com.liferay.portal.kernel.exception.SystemException;
116    
117            /**
118            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
119            *
120            * <p>
121            * 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.
122            * </p>
123            *
124            * @param dynamicQuery the dynamic query
125            * @param start the lower bound of the range of model instances
126            * @param end the upper bound of the range of model instances (not inclusive)
127            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
128            * @return the ordered range of matching rows
129            * @throws SystemException if a system exception occurred
130            */
131            @SuppressWarnings("rawtypes")
132            public java.util.List dynamicQuery(
133                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
134                    int end,
135                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
136                    throws com.liferay.portal.kernel.exception.SystemException;
137    
138            /**
139            * Returns the number of rows that match the dynamic query.
140            *
141            * @param dynamicQuery the dynamic query
142            * @return the number of rows that match the dynamic query
143            * @throws SystemException if a system exception occurred
144            */
145            public long dynamicQueryCount(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
147                    throws com.liferay.portal.kernel.exception.SystemException;
148    
149            /**
150            * Returns the cal event with the primary key.
151            *
152            * @param eventId the primary key of the cal event
153            * @return the cal event
154            * @throws PortalException if a cal event with the primary key could not be found
155            * @throws SystemException if a system exception occurred
156            */
157            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
158            public com.liferay.portlet.calendar.model.CalEvent getCalEvent(long eventId)
159                    throws com.liferay.portal.kernel.exception.PortalException,
160                            com.liferay.portal.kernel.exception.SystemException;
161    
162            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
163            public com.liferay.portal.model.PersistedModel getPersistedModel(
164                    java.io.Serializable primaryKeyObj)
165                    throws com.liferay.portal.kernel.exception.PortalException,
166                            com.liferay.portal.kernel.exception.SystemException;
167    
168            /**
169            * Returns the cal event with the UUID in the group.
170            *
171            * @param uuid the UUID of cal event
172            * @param groupId the group id of the cal event
173            * @return the cal event
174            * @throws PortalException if a cal event with the UUID in the group could not be found
175            * @throws SystemException if a system exception occurred
176            */
177            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
178            public com.liferay.portlet.calendar.model.CalEvent getCalEventByUuidAndGroupId(
179                    java.lang.String uuid, long groupId)
180                    throws com.liferay.portal.kernel.exception.PortalException,
181                            com.liferay.portal.kernel.exception.SystemException;
182    
183            /**
184            * Returns a range of all the cal events.
185            *
186            * <p>
187            * 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.
188            * </p>
189            *
190            * @param start the lower bound of the range of cal events
191            * @param end the upper bound of the range of cal events (not inclusive)
192            * @return the range of cal events
193            * @throws SystemException if a system exception occurred
194            */
195            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
196            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getCalEvents(
197                    int start, int end)
198                    throws com.liferay.portal.kernel.exception.SystemException;
199    
200            /**
201            * Returns the number of cal events.
202            *
203            * @return the number of cal events
204            * @throws SystemException if a system exception occurred
205            */
206            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
207            public int getCalEventsCount()
208                    throws com.liferay.portal.kernel.exception.SystemException;
209    
210            /**
211            * Updates the cal event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
212            *
213            * @param calEvent the cal event
214            * @return the cal event that was updated
215            * @throws SystemException if a system exception occurred
216            */
217            public com.liferay.portlet.calendar.model.CalEvent updateCalEvent(
218                    com.liferay.portlet.calendar.model.CalEvent calEvent)
219                    throws com.liferay.portal.kernel.exception.SystemException;
220    
221            /**
222            * Updates the cal event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
223            *
224            * @param calEvent the cal event
225            * @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.
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, boolean merge)
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                    int startDateMonth, int startDateDay, int startDateYear,
250                    int startDateHour, int startDateMinute, int endDateMonth,
251                    int endDateDay, int endDateYear, int durationHour, int durationMinute,
252                    boolean allDay, boolean timeZoneSensitive, java.lang.String type,
253                    boolean repeating,
254                    com.liferay.portal.kernel.cal.TZSRecurrence recurrence, int remindBy,
255                    int firstReminder, int secondReminder,
256                    com.liferay.portal.service.ServiceContext serviceContext)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException;
259    
260            public void addEventResources(
261                    com.liferay.portlet.calendar.model.CalEvent event,
262                    boolean addCommunityPermissions, boolean addGuestPermissions)
263                    throws com.liferay.portal.kernel.exception.PortalException,
264                            com.liferay.portal.kernel.exception.SystemException;
265    
266            public void addEventResources(
267                    com.liferay.portlet.calendar.model.CalEvent event,
268                    java.lang.String[] communityPermissions,
269                    java.lang.String[] guestPermissions)
270                    throws com.liferay.portal.kernel.exception.PortalException,
271                            com.liferay.portal.kernel.exception.SystemException;
272    
273            public void addEventResources(long eventId,
274                    boolean addCommunityPermissions, boolean addGuestPermissions)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException;
277    
278            public void addEventResources(long eventId,
279                    java.lang.String[] communityPermissions,
280                    java.lang.String[] guestPermissions)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException;
283    
284            public void checkEvents()
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException;
287    
288            public void deleteEvent(com.liferay.portlet.calendar.model.CalEvent event)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException;
291    
292            public void deleteEvent(long eventId)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException;
295    
296            public void deleteEvents(long groupId)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException;
299    
300            public java.io.File exportEvent(long userId, long eventId)
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException;
303    
304            public java.io.File exportGroupEvents(long userId, long groupId,
305                    java.lang.String fileName)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException;
308    
309            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
310            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getCompanyEvents(
311                    long companyId, int start, int end)
312                    throws com.liferay.portal.kernel.exception.SystemException;
313    
314            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
315            public int getCompanyEventsCount(long companyId)
316                    throws com.liferay.portal.kernel.exception.SystemException;
317    
318            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
319            public com.liferay.portlet.calendar.model.CalEvent getEvent(long eventId)
320                    throws com.liferay.portal.kernel.exception.PortalException,
321                            com.liferay.portal.kernel.exception.SystemException;
322    
323            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
324            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
325                    long groupId, java.util.Calendar cal)
326                    throws com.liferay.portal.kernel.exception.SystemException;
327    
328            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
329            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getEvents(
330                    long groupId, java.util.Calendar cal, java.lang.String type)
331                    throws 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.lang.String type, int start, int end)
336                    throws com.liferay.portal.kernel.exception.SystemException;
337    
338            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
339            public int getEventsCount(long groupId, java.lang.String type)
340                    throws com.liferay.portal.kernel.exception.SystemException;
341    
342            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
343            public java.util.List<com.liferay.portlet.calendar.model.CalEvent> getNoAssetEvents()
344                    throws 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> getRepeatingEvents(
348                    long groupId)
349                    throws com.liferay.portal.kernel.exception.SystemException;
350    
351            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
352            public boolean hasEvents(long groupId, java.util.Calendar cal)
353                    throws com.liferay.portal.kernel.exception.SystemException;
354    
355            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
356            public boolean hasEvents(long groupId, java.util.Calendar cal,
357                    java.lang.String type)
358                    throws com.liferay.portal.kernel.exception.SystemException;
359    
360            public void importICal4j(long userId, long groupId, java.io.File file)
361                    throws com.liferay.portal.kernel.exception.PortalException,
362                            com.liferay.portal.kernel.exception.SystemException;
363    
364            public void updateAsset(long userId,
365                    com.liferay.portlet.calendar.model.CalEvent event,
366                    long[] assetCategoryIds, java.lang.String[] assetTagNames)
367                    throws com.liferay.portal.kernel.exception.PortalException,
368                            com.liferay.portal.kernel.exception.SystemException;
369    
370            public com.liferay.portlet.calendar.model.CalEvent updateEvent(
371                    long userId, long eventId, java.lang.String title,
372                    java.lang.String description, int startDateMonth, int startDateDay,
373                    int startDateYear, int startDateHour, int startDateMinute,
374                    int endDateMonth, int endDateDay, int endDateYear, int durationHour,
375                    int durationMinute, boolean allDay, boolean timeZoneSensitive,
376                    java.lang.String type, boolean repeating,
377                    com.liferay.portal.kernel.cal.TZSRecurrence recurrence, int remindBy,
378                    int firstReminder, int secondReminder,
379                    com.liferay.portal.service.ServiceContext serviceContext)
380                    throws com.liferay.portal.kernel.exception.PortalException,
381                            com.liferay.portal.kernel.exception.SystemException;
382    }