001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.announcements.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 announcements entry 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 AnnouncementsEntryLocalServiceUtil
034     * @see com.liferay.portlet.announcements.service.base.AnnouncementsEntryLocalServiceBaseImpl
035     * @see com.liferay.portlet.announcements.service.impl.AnnouncementsEntryLocalServiceImpl
036     * @generated
037     */
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface AnnouncementsEntryLocalService extends BaseLocalService,
041            PersistedModelLocalService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * 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.
046             */
047    
048            /**
049            * Adds the announcements entry to the database. Also notifies the appropriate model listeners.
050            *
051            * @param announcementsEntry the announcements entry
052            * @return the announcements entry that was added
053            * @throws SystemException if a system exception occurred
054            */
055            public com.liferay.portlet.announcements.model.AnnouncementsEntry addAnnouncementsEntry(
056                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry)
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            /**
060            * Creates a new announcements entry with the primary key. Does not add the announcements entry to the database.
061            *
062            * @param entryId the primary key for the new announcements entry
063            * @return the new announcements entry
064            */
065            public com.liferay.portlet.announcements.model.AnnouncementsEntry createAnnouncementsEntry(
066                    long entryId);
067    
068            /**
069            * Deletes the announcements entry with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param entryId the primary key of the announcements entry
072            * @return the announcements entry that was removed
073            * @throws PortalException if a announcements entry with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public com.liferay.portlet.announcements.model.AnnouncementsEntry deleteAnnouncementsEntry(
077                    long entryId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            /**
082            * Deletes the announcements entry from the database. Also notifies the appropriate model listeners.
083            *
084            * @param announcementsEntry the announcements entry
085            * @return the announcements entry that was removed
086            * @throws SystemException if a system exception occurred
087            */
088            public com.liferay.portlet.announcements.model.AnnouncementsEntry deleteAnnouncementsEntry(
089                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry)
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.announcements.model.AnnouncementsEntry fetchAnnouncementsEntry(
158                    long entryId)
159                    throws com.liferay.portal.kernel.exception.SystemException;
160    
161            /**
162            * Returns the announcements entry with the primary key.
163            *
164            * @param entryId the primary key of the announcements entry
165            * @return the announcements entry
166            * @throws PortalException if a announcements entry 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.announcements.model.AnnouncementsEntry getAnnouncementsEntry(
171                    long entryId)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException;
180    
181            /**
182            * Returns a range of all the announcements entries.
183            *
184            * <p>
185            * 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.
186            * </p>
187            *
188            * @param start the lower bound of the range of announcements entries
189            * @param end the upper bound of the range of announcements entries (not inclusive)
190            * @return the range of announcements entries
191            * @throws SystemException if a system exception occurred
192            */
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getAnnouncementsEntries(
195                    int start, int end)
196                    throws com.liferay.portal.kernel.exception.SystemException;
197    
198            /**
199            * Returns the number of announcements entries.
200            *
201            * @return the number of announcements entries
202            * @throws SystemException if a system exception occurred
203            */
204            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
205            public int getAnnouncementsEntriesCount()
206                    throws com.liferay.portal.kernel.exception.SystemException;
207    
208            /**
209            * Updates the announcements entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
210            *
211            * @param announcementsEntry the announcements entry
212            * @return the announcements entry that was updated
213            * @throws SystemException if a system exception occurred
214            */
215            public com.liferay.portlet.announcements.model.AnnouncementsEntry updateAnnouncementsEntry(
216                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry)
217                    throws com.liferay.portal.kernel.exception.SystemException;
218    
219            /**
220            * Updates the announcements entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
221            *
222            * @param announcementsEntry the announcements entry
223            * @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.
224            * @return the announcements entry that was updated
225            * @throws SystemException if a system exception occurred
226            */
227            public com.liferay.portlet.announcements.model.AnnouncementsEntry updateAnnouncementsEntry(
228                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry,
229                    boolean merge)
230                    throws com.liferay.portal.kernel.exception.SystemException;
231    
232            /**
233            * Returns the Spring bean ID for this bean.
234            *
235            * @return the Spring bean ID for this bean
236            */
237            public java.lang.String getBeanIdentifier();
238    
239            /**
240            * Sets the Spring bean ID for this bean.
241            *
242            * @param beanIdentifier the Spring bean ID for this bean
243            */
244            public void setBeanIdentifier(java.lang.String beanIdentifier);
245    
246            public com.liferay.portlet.announcements.model.AnnouncementsEntry addEntry(
247                    long userId, long classNameId, long classPK, java.lang.String title,
248                    java.lang.String content, java.lang.String url, java.lang.String type,
249                    int displayDateMonth, int displayDateDay, int displayDateYear,
250                    int displayDateHour, int displayDateMinute, boolean autoDisplayDate,
251                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
252                    int expirationDateHour, int expirationDateMinute, int priority,
253                    boolean alert)
254                    throws com.liferay.portal.kernel.exception.PortalException,
255                            com.liferay.portal.kernel.exception.SystemException;
256    
257            /**
258            * @deprecated As of 6.2.0, replaced by {@link #addEntry(long, long, long,
259            String, String, String, String, int, int, int, int, int,
260            boolean, int, int, int, int, int, int, boolean)}
261            */
262            public com.liferay.portlet.announcements.model.AnnouncementsEntry addEntry(
263                    long userId, long classNameId, long classPK, java.lang.String title,
264                    java.lang.String content, java.lang.String url, java.lang.String type,
265                    int displayDateMonth, int displayDateDay, int displayDateYear,
266                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
267                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
268                    int expirationDateMinute, int priority, boolean alert)
269                    throws com.liferay.portal.kernel.exception.PortalException,
270                            com.liferay.portal.kernel.exception.SystemException;
271    
272            public void checkEntries()
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException;
275    
276            public void deleteEntry(
277                    com.liferay.portlet.announcements.model.AnnouncementsEntry entry)
278                    throws com.liferay.portal.kernel.exception.PortalException,
279                            com.liferay.portal.kernel.exception.SystemException;
280    
281            public void deleteEntry(long entryId)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException;
284    
285            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
286            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
287                    long userId, java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
288                    boolean alert, int flagValue, int start, int end)
289                    throws com.liferay.portal.kernel.exception.SystemException;
290    
291            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
292            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
293                    long userId, java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
294                    int displayDateMonth, int displayDateDay, int displayDateYear,
295                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
296                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
297                    int expirationDateMinute, boolean alert, int flagValue, int start,
298                    int end) throws com.liferay.portal.kernel.exception.SystemException;
299    
300            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
301            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
302                    long classNameId, long classPK, boolean alert, int start, int end)
303                    throws com.liferay.portal.kernel.exception.SystemException;
304    
305            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
306            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
307                    long userId, long classNameId, long[] classPKs, int displayDateMonth,
308                    int displayDateDay, int displayDateYear, int displayDateHour,
309                    int displayDateMinute, int expirationDateMonth, int expirationDateDay,
310                    int expirationDateYear, int expirationDateHour,
311                    int expirationDateMinute, boolean alert, int flagValue, int start,
312                    int end) throws com.liferay.portal.kernel.exception.SystemException;
313    
314            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
315            public int getEntriesCount(long userId,
316                    java.util.LinkedHashMap<java.lang.Long, long[]> scopes, boolean alert,
317                    int flagValue)
318                    throws com.liferay.portal.kernel.exception.SystemException;
319    
320            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
321            public int getEntriesCount(long userId,
322                    java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
323                    int displayDateMonth, int displayDateDay, int displayDateYear,
324                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
325                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
326                    int expirationDateMinute, boolean alert, int flagValue)
327                    throws com.liferay.portal.kernel.exception.SystemException;
328    
329            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
330            public int getEntriesCount(long classNameId, long classPK, boolean alert)
331                    throws com.liferay.portal.kernel.exception.SystemException;
332    
333            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
334            public int getEntriesCount(long userId, long classNameId, long[] classPKs,
335                    boolean alert, int flagValue)
336                    throws com.liferay.portal.kernel.exception.SystemException;
337    
338            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
339            public int getEntriesCount(long userId, long classNameId, long[] classPKs,
340                    int displayDateMonth, int displayDateDay, int displayDateYear,
341                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
342                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
343                    int expirationDateMinute, boolean alert, int flagValue)
344                    throws com.liferay.portal.kernel.exception.SystemException;
345    
346            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
347            public com.liferay.portlet.announcements.model.AnnouncementsEntry getEntry(
348                    long entryId)
349                    throws com.liferay.portal.kernel.exception.PortalException,
350                            com.liferay.portal.kernel.exception.SystemException;
351    
352            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
353            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getUserEntries(
354                    long userId, int start, int end)
355                    throws com.liferay.portal.kernel.exception.SystemException;
356    
357            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
358            public int getUserEntriesCount(long userId)
359                    throws com.liferay.portal.kernel.exception.SystemException;
360    
361            public com.liferay.portlet.announcements.model.AnnouncementsEntry updateEntry(
362                    long userId, long entryId, java.lang.String title,
363                    java.lang.String content, java.lang.String url, java.lang.String type,
364                    int displayDateMonth, int displayDateDay, int displayDateYear,
365                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
366                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
367                    int expirationDateMinute, int priority)
368                    throws com.liferay.portal.kernel.exception.PortalException,
369                            com.liferay.portal.kernel.exception.SystemException;
370    }