001    /**
002     * Copyright (c) 2000-2012 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            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
151            public com.liferay.portlet.announcements.model.AnnouncementsEntry fetchAnnouncementsEntry(
152                    long entryId)
153                    throws com.liferay.portal.kernel.exception.SystemException;
154    
155            /**
156            * Returns the announcements entry with the primary key.
157            *
158            * @param entryId the primary key of the announcements entry
159            * @return the announcements entry
160            * @throws PortalException if a announcements entry with the primary key could not be found
161            * @throws SystemException if a system exception occurred
162            */
163            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
164            public com.liferay.portlet.announcements.model.AnnouncementsEntry getAnnouncementsEntry(
165                    long entryId)
166                    throws com.liferay.portal.kernel.exception.PortalException,
167                            com.liferay.portal.kernel.exception.SystemException;
168    
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public com.liferay.portal.model.PersistedModel getPersistedModel(
171                    java.io.Serializable primaryKeyObj)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            /**
176            * Returns a range of all the announcements entries.
177            *
178            * <p>
179            * 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.
180            * </p>
181            *
182            * @param start the lower bound of the range of announcements entries
183            * @param end the upper bound of the range of announcements entries (not inclusive)
184            * @return the range of announcements entries
185            * @throws SystemException if a system exception occurred
186            */
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getAnnouncementsEntries(
189                    int start, int end)
190                    throws com.liferay.portal.kernel.exception.SystemException;
191    
192            /**
193            * Returns the number of announcements entries.
194            *
195            * @return the number of announcements entries
196            * @throws SystemException if a system exception occurred
197            */
198            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
199            public int getAnnouncementsEntriesCount()
200                    throws com.liferay.portal.kernel.exception.SystemException;
201    
202            /**
203            * Updates the announcements entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
204            *
205            * @param announcementsEntry the announcements entry
206            * @return the announcements entry that was updated
207            * @throws SystemException if a system exception occurred
208            */
209            public com.liferay.portlet.announcements.model.AnnouncementsEntry updateAnnouncementsEntry(
210                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry)
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            /**
214            * Updates the announcements entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
215            *
216            * @param announcementsEntry the announcements entry
217            * @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.
218            * @return the announcements entry that was updated
219            * @throws SystemException if a system exception occurred
220            */
221            public com.liferay.portlet.announcements.model.AnnouncementsEntry updateAnnouncementsEntry(
222                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry,
223                    boolean merge)
224                    throws com.liferay.portal.kernel.exception.SystemException;
225    
226            /**
227            * Returns the Spring bean ID for this bean.
228            *
229            * @return the Spring bean ID for this bean
230            */
231            public java.lang.String getBeanIdentifier();
232    
233            /**
234            * Sets the Spring bean ID for this bean.
235            *
236            * @param beanIdentifier the Spring bean ID for this bean
237            */
238            public void setBeanIdentifier(java.lang.String beanIdentifier);
239    
240            public com.liferay.portlet.announcements.model.AnnouncementsEntry addEntry(
241                    long userId, long classNameId, long classPK, java.lang.String title,
242                    java.lang.String content, java.lang.String url, java.lang.String type,
243                    int displayDateMonth, int displayDateDay, int displayDateYear,
244                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
245                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
246                    int expirationDateMinute, int priority, boolean alert)
247                    throws com.liferay.portal.kernel.exception.PortalException,
248                            com.liferay.portal.kernel.exception.SystemException;
249    
250            public void checkEntries()
251                    throws com.liferay.portal.kernel.exception.PortalException,
252                            com.liferay.portal.kernel.exception.SystemException;
253    
254            public void deleteEntry(
255                    com.liferay.portlet.announcements.model.AnnouncementsEntry entry)
256                    throws com.liferay.portal.kernel.exception.PortalException,
257                            com.liferay.portal.kernel.exception.SystemException;
258    
259            public void deleteEntry(long entryId)
260                    throws com.liferay.portal.kernel.exception.PortalException,
261                            com.liferay.portal.kernel.exception.SystemException;
262    
263            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
264            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
265                    long userId, java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
266                    boolean alert, int flagValue, int start, int end)
267                    throws com.liferay.portal.kernel.exception.SystemException;
268    
269            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
270            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
271                    long userId, 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, int start,
276                    int end) 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 classNameId, long classPK, boolean alert, int start, int end)
281                    throws com.liferay.portal.kernel.exception.SystemException;
282    
283            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
284            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
285                    long userId, long classNameId, long[] classPKs, int displayDateMonth,
286                    int displayDateDay, int displayDateYear, int displayDateHour,
287                    int displayDateMinute, int expirationDateMonth, int expirationDateDay,
288                    int expirationDateYear, int expirationDateHour,
289                    int expirationDateMinute, boolean alert, int flagValue, int start,
290                    int end) throws com.liferay.portal.kernel.exception.SystemException;
291    
292            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
293            public int getEntriesCount(long userId,
294                    java.util.LinkedHashMap<java.lang.Long, long[]> scopes, boolean alert,
295                    int flagValue)
296                    throws com.liferay.portal.kernel.exception.SystemException;
297    
298            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
299            public int getEntriesCount(long userId,
300                    java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
301                    int displayDateMonth, int displayDateDay, int displayDateYear,
302                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
303                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
304                    int expirationDateMinute, boolean alert, int flagValue)
305                    throws com.liferay.portal.kernel.exception.SystemException;
306    
307            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
308            public int getEntriesCount(long classNameId, long classPK, boolean alert)
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                    boolean alert, int flagValue)
314                    throws com.liferay.portal.kernel.exception.SystemException;
315    
316            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
317            public int getEntriesCount(long userId, long classNameId, long[] classPKs,
318                    int displayDateMonth, int displayDateDay, int displayDateYear,
319                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
320                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
321                    int expirationDateMinute, boolean alert, int flagValue)
322                    throws com.liferay.portal.kernel.exception.SystemException;
323    
324            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
325            public com.liferay.portlet.announcements.model.AnnouncementsEntry getEntry(
326                    long entryId)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException;
329    
330            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
331            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getUserEntries(
332                    long userId, int start, int end)
333                    throws com.liferay.portal.kernel.exception.SystemException;
334    
335            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
336            public int getUserEntriesCount(long userId)
337                    throws com.liferay.portal.kernel.exception.SystemException;
338    
339            public com.liferay.portlet.announcements.model.AnnouncementsEntry updateEntry(
340                    long userId, long entryId, java.lang.String title,
341                    java.lang.String content, java.lang.String url, java.lang.String type,
342                    int displayDateMonth, int displayDateDay, int displayDateYear,
343                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
344                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
345                    int expirationDateMinute, int priority)
346                    throws com.liferay.portal.kernel.exception.PortalException,
347                            com.liferay.portal.kernel.exception.SystemException;
348    }