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