001    /**
002     * Copyright (c) 2000-2010 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.announcements.service;
016    
017    import com.liferay.portal.kernel.annotation.Isolation;
018    import com.liferay.portal.kernel.annotation.Propagation;
019    import com.liferay.portal.kernel.annotation.Transactional;
020    import com.liferay.portal.kernel.exception.PortalException;
021    import com.liferay.portal.kernel.exception.SystemException;
022    
023    /**
024     * The interface for the announcements entry local service.
025     *
026     * <p>
027     * Never modify or reference this interface directly. Always use {@link AnnouncementsEntryLocalServiceUtil} to access the announcements entry local service. Add custom service methods to {@link com.liferay.portlet.announcements.service.impl.AnnouncementsEntryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
028     * </p>
029     *
030     * <p>
031     * 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.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see AnnouncementsEntryLocalServiceUtil
036     * @see com.liferay.portlet.announcements.service.base.AnnouncementsEntryLocalServiceBaseImpl
037     * @see com.liferay.portlet.announcements.service.impl.AnnouncementsEntryLocalServiceImpl
038     * @generated
039     */
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface AnnouncementsEntryLocalService {
043            /**
044            * Adds the announcements entry to the database. Also notifies the appropriate model listeners.
045            *
046            * @param announcementsEntry the announcements entry to add
047            * @return the announcements entry that was added
048            * @throws SystemException if a system exception occurred
049            */
050            public com.liferay.portlet.announcements.model.AnnouncementsEntry addAnnouncementsEntry(
051                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry)
052                    throws com.liferay.portal.kernel.exception.SystemException;
053    
054            /**
055            * Creates a new announcements entry with the primary key. Does not add the announcements entry to the database.
056            *
057            * @param entryId the primary key for the new announcements entry
058            * @return the new announcements entry
059            */
060            public com.liferay.portlet.announcements.model.AnnouncementsEntry createAnnouncementsEntry(
061                    long entryId);
062    
063            /**
064            * Deletes the announcements entry with the primary key from the database. Also notifies the appropriate model listeners.
065            *
066            * @param entryId the primary key of the announcements entry to delete
067            * @throws PortalException if a announcements entry with the primary key could not be found
068            * @throws SystemException if a system exception occurred
069            */
070            public void deleteAnnouncementsEntry(long entryId)
071                    throws com.liferay.portal.kernel.exception.PortalException,
072                            com.liferay.portal.kernel.exception.SystemException;
073    
074            /**
075            * Deletes the announcements entry from the database. Also notifies the appropriate model listeners.
076            *
077            * @param announcementsEntry the announcements entry to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public void deleteAnnouncementsEntry(
081                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry)
082                    throws com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Performs a dynamic query on the database and returns the matching rows.
086            *
087            * @param dynamicQuery the dynamic query to search with
088            * @return the matching rows
089            * @throws SystemException if a system exception occurred
090            */
091            @SuppressWarnings("rawtypes")
092            public java.util.List dynamicQuery(
093                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
094                    throws com.liferay.portal.kernel.exception.SystemException;
095    
096            /**
097            * Performs a dynamic query on the database and returns a range of the matching rows.
098            *
099            * <p>
100            * 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.
101            * </p>
102            *
103            * @param dynamicQuery the dynamic query to search with
104            * @param start the lower bound of the range of model instances to return
105            * @param end the upper bound of the range of model instances to return (not inclusive)
106            * @return the range of matching rows
107            * @throws SystemException if a system exception occurred
108            */
109            @SuppressWarnings("rawtypes")
110            public java.util.List dynamicQuery(
111                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
112                    int end) throws com.liferay.portal.kernel.exception.SystemException;
113    
114            /**
115            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
116            *
117            * <p>
118            * 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query to search with
122            * @param start the lower bound of the range of model instances to return
123            * @param end the upper bound of the range of model instances to return (not inclusive)
124            * @param orderByComparator the comparator to order the results by
125            * @return the ordered range of matching rows
126            * @throws SystemException if a system exception occurred
127            */
128            @SuppressWarnings("rawtypes")
129            public java.util.List dynamicQuery(
130                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
131                    int end,
132                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
133                    throws com.liferay.portal.kernel.exception.SystemException;
134    
135            /**
136            * Counts the number of rows that match the dynamic query.
137            *
138            * @param dynamicQuery the dynamic query to search with
139            * @return the number of rows that match the dynamic query
140            * @throws SystemException if a system exception occurred
141            */
142            public long dynamicQueryCount(
143                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
144                    throws com.liferay.portal.kernel.exception.SystemException;
145    
146            /**
147            * Gets the announcements entry with the primary key.
148            *
149            * @param entryId the primary key of the announcements entry to get
150            * @return the announcements entry
151            * @throws PortalException if a announcements entry with the primary key could not be found
152            * @throws SystemException if a system exception occurred
153            */
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public com.liferay.portlet.announcements.model.AnnouncementsEntry getAnnouncementsEntry(
156                    long entryId)
157                    throws com.liferay.portal.kernel.exception.PortalException,
158                            com.liferay.portal.kernel.exception.SystemException;
159    
160            /**
161            * Gets a range of all the announcements entries.
162            *
163            * <p>
164            * 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.
165            * </p>
166            *
167            * @param start the lower bound of the range of announcements entries to return
168            * @param end the upper bound of the range of announcements entries to return (not inclusive)
169            * @return the range of announcements entries
170            * @throws SystemException if a system exception occurred
171            */
172            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
173            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getAnnouncementsEntries(
174                    int start, int end)
175                    throws com.liferay.portal.kernel.exception.SystemException;
176    
177            /**
178            * Gets the number of announcements entries.
179            *
180            * @return the number of announcements entries
181            * @throws SystemException if a system exception occurred
182            */
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public int getAnnouncementsEntriesCount()
185                    throws com.liferay.portal.kernel.exception.SystemException;
186    
187            /**
188            * Updates the announcements entry in the database. Also notifies the appropriate model listeners.
189            *
190            * @param announcementsEntry the announcements entry to update
191            * @return the announcements entry that was updated
192            * @throws SystemException if a system exception occurred
193            */
194            public com.liferay.portlet.announcements.model.AnnouncementsEntry updateAnnouncementsEntry(
195                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry)
196                    throws com.liferay.portal.kernel.exception.SystemException;
197    
198            /**
199            * Updates the announcements entry in the database. Also notifies the appropriate model listeners.
200            *
201            * @param announcementsEntry the announcements entry to update
202            * @param merge whether to merge the announcements entry 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.
203            * @return the announcements entry that was updated
204            * @throws SystemException if a system exception occurred
205            */
206            public com.liferay.portlet.announcements.model.AnnouncementsEntry updateAnnouncementsEntry(
207                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry,
208                    boolean merge)
209                    throws com.liferay.portal.kernel.exception.SystemException;
210    
211            public com.liferay.portlet.announcements.model.AnnouncementsEntry addEntry(
212                    long userId, long classNameId, long classPK, java.lang.String title,
213                    java.lang.String content, java.lang.String url, java.lang.String type,
214                    int displayDateMonth, int displayDateDay, int displayDateYear,
215                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
216                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
217                    int expirationDateMinute, int priority, boolean alert)
218                    throws com.liferay.portal.kernel.exception.PortalException,
219                            com.liferay.portal.kernel.exception.SystemException;
220    
221            public void checkEntries()
222                    throws com.liferay.portal.kernel.exception.PortalException,
223                            com.liferay.portal.kernel.exception.SystemException;
224    
225            public void deleteEntry(
226                    com.liferay.portlet.announcements.model.AnnouncementsEntry entry)
227                    throws com.liferay.portal.kernel.exception.PortalException,
228                            com.liferay.portal.kernel.exception.SystemException;
229    
230            public void deleteEntry(long entryId)
231                    throws com.liferay.portal.kernel.exception.PortalException,
232                            com.liferay.portal.kernel.exception.SystemException;
233    
234            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
235            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
236                    long userId, java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
237                    boolean alert, int flagValue, int start, int end)
238                    throws com.liferay.portal.kernel.exception.SystemException;
239    
240            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
241            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
242                    long userId, java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
243                    int displayDateMonth, int displayDateDay, int displayDateYear,
244                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
245                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
246                    int expirationDateMinute, boolean alert, int flagValue, int start,
247                    int end) throws com.liferay.portal.kernel.exception.SystemException;
248    
249            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
250            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
251                    long classNameId, long classPK, boolean alert, int start, int end)
252                    throws com.liferay.portal.kernel.exception.SystemException;
253    
254            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
255            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
256                    long userId, long classNameId, long[] classPKs, int displayDateMonth,
257                    int displayDateDay, int displayDateYear, int displayDateHour,
258                    int displayDateMinute, int expirationDateMonth, int expirationDateDay,
259                    int expirationDateYear, int expirationDateHour,
260                    int expirationDateMinute, boolean alert, int flagValue, int start,
261                    int end) throws com.liferay.portal.kernel.exception.SystemException;
262    
263            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
264            public int getEntriesCount(long userId,
265                    java.util.LinkedHashMap<java.lang.Long, long[]> scopes, boolean alert,
266                    int flagValue)
267                    throws com.liferay.portal.kernel.exception.SystemException;
268    
269            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
270            public int getEntriesCount(long userId,
271                    java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
272                    int displayDateMonth, int displayDateDay, int displayDateYear,
273                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
274                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
275                    int expirationDateMinute, boolean alert, int flagValue)
276                    throws com.liferay.portal.kernel.exception.SystemException;
277    
278            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
279            public int getEntriesCount(long classNameId, long classPK, boolean alert)
280                    throws com.liferay.portal.kernel.exception.SystemException;
281    
282            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
283            public int getEntriesCount(long userId, long classNameId, long[] classPKs,
284                    boolean alert, int flagValue)
285                    throws com.liferay.portal.kernel.exception.SystemException;
286    
287            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
288            public int getEntriesCount(long userId, long classNameId, long[] classPKs,
289                    int displayDateMonth, int displayDateDay, int displayDateYear,
290                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
291                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
292                    int expirationDateMinute, boolean alert, int flagValue)
293                    throws com.liferay.portal.kernel.exception.SystemException;
294    
295            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
296            public com.liferay.portlet.announcements.model.AnnouncementsEntry getEntry(
297                    long entryId)
298                    throws com.liferay.portal.kernel.exception.PortalException,
299                            com.liferay.portal.kernel.exception.SystemException;
300    
301            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
302            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getUserEntries(
303                    long userId, int start, int end)
304                    throws com.liferay.portal.kernel.exception.SystemException;
305    
306            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
307            public int getUserEntriesCount(long userId)
308                    throws com.liferay.portal.kernel.exception.SystemException;
309    
310            public com.liferay.portlet.announcements.model.AnnouncementsEntry updateEntry(
311                    long userId, long entryId, java.lang.String title,
312                    java.lang.String content, java.lang.String url, java.lang.String type,
313                    int displayDateMonth, int displayDateDay, int displayDateYear,
314                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
315                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
316                    int expirationDateMinute, int priority)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException;
319    }