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     * Provides the local service interface for AnnouncementsEntry. Methods of this
027     * service will not have security checks based on the propagated JAAS
028     * credentials because this service can only be accessed from within the same
029     * VM.
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 extends BaseLocalService,
040            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            * @return the announcements entry that was removed
072            * @throws PortalException if a announcements entry with the primary key could not be found
073            * @throws SystemException if a system exception occurred
074            */
075            public com.liferay.portlet.announcements.model.AnnouncementsEntry deleteAnnouncementsEntry(
076                    long entryId)
077                    throws com.liferay.portal.kernel.exception.PortalException,
078                            com.liferay.portal.kernel.exception.SystemException;
079    
080            /**
081            * Deletes the announcements entry from the database. Also notifies the appropriate model listeners.
082            *
083            * @param announcementsEntry the announcements entry
084            * @return the announcements entry that was removed
085            * @throws SystemException if a system exception occurred
086            */
087            public com.liferay.portlet.announcements.model.AnnouncementsEntry deleteAnnouncementsEntry(
088                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry)
089                    throws com.liferay.portal.kernel.exception.SystemException;
090    
091            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
092    
093            /**
094            * Performs a dynamic query on the database and returns the matching rows.
095            *
096            * @param dynamicQuery the dynamic query
097            * @return the matching rows
098            * @throws SystemException if a system exception occurred
099            */
100            @SuppressWarnings("rawtypes")
101            public java.util.List dynamicQuery(
102                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
103                    throws com.liferay.portal.kernel.exception.SystemException;
104    
105            /**
106            * Performs a dynamic query on the database and returns a range of the matching rows.
107            *
108            * <p>
109            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.announcements.model.impl.AnnouncementsEntryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
110            * </p>
111            *
112            * @param dynamicQuery the dynamic query
113            * @param start the lower bound of the range of model instances
114            * @param end the upper bound of the range of model instances (not inclusive)
115            * @return the range of matching rows
116            * @throws SystemException if a system exception occurred
117            */
118            @SuppressWarnings("rawtypes")
119            public java.util.List dynamicQuery(
120                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
121                    int end) throws com.liferay.portal.kernel.exception.SystemException;
122    
123            /**
124            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
125            *
126            * <p>
127            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.announcements.model.impl.AnnouncementsEntryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
128            * </p>
129            *
130            * @param dynamicQuery the dynamic query
131            * @param start the lower bound of the range of model instances
132            * @param end the upper bound of the range of model instances (not inclusive)
133            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
134            * @return the ordered range of matching rows
135            * @throws SystemException if a system exception occurred
136            */
137            @SuppressWarnings("rawtypes")
138            public java.util.List dynamicQuery(
139                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
140                    int end,
141                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
142                    throws com.liferay.portal.kernel.exception.SystemException;
143    
144            /**
145            * Returns the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException;
154    
155            /**
156            * Returns the number of rows that match the dynamic query.
157            *
158            * @param dynamicQuery the dynamic query
159            * @param projection the projection to apply to the query
160            * @return the number of rows that match the dynamic query
161            * @throws SystemException if a system exception occurred
162            */
163            public long dynamicQueryCount(
164                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
165                    com.liferay.portal.kernel.dao.orm.Projection projection)
166                    throws com.liferay.portal.kernel.exception.SystemException;
167    
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portlet.announcements.model.AnnouncementsEntry fetchAnnouncementsEntry(
170                    long entryId)
171                    throws com.liferay.portal.kernel.exception.SystemException;
172    
173            /**
174            * Returns the announcements entry with the matching UUID and company.
175            *
176            * @param uuid the announcements entry's UUID
177            * @param companyId the primary key of the company
178            * @return the matching announcements entry, or <code>null</code> if a matching announcements entry could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
182            public com.liferay.portlet.announcements.model.AnnouncementsEntry fetchAnnouncementsEntryByUuidAndCompanyId(
183                    java.lang.String uuid, long companyId)
184                    throws com.liferay.portal.kernel.exception.SystemException;
185    
186            /**
187            * Returns the announcements entry with the primary key.
188            *
189            * @param entryId the primary key of the announcements entry
190            * @return the announcements entry
191            * @throws PortalException if a announcements entry with the primary key could not be found
192            * @throws SystemException if a system exception occurred
193            */
194            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
195            public com.liferay.portlet.announcements.model.AnnouncementsEntry getAnnouncementsEntry(
196                    long entryId)
197                    throws com.liferay.portal.kernel.exception.PortalException,
198                            com.liferay.portal.kernel.exception.SystemException;
199    
200            @Override
201            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
202            public com.liferay.portal.model.PersistedModel getPersistedModel(
203                    java.io.Serializable primaryKeyObj)
204                    throws com.liferay.portal.kernel.exception.PortalException,
205                            com.liferay.portal.kernel.exception.SystemException;
206    
207            /**
208            * Returns the announcements entry with the matching UUID and company.
209            *
210            * @param uuid the announcements entry's UUID
211            * @param companyId the primary key of the company
212            * @return the matching announcements entry
213            * @throws PortalException if a matching announcements entry could not be found
214            * @throws SystemException if a system exception occurred
215            */
216            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
217            public com.liferay.portlet.announcements.model.AnnouncementsEntry getAnnouncementsEntryByUuidAndCompanyId(
218                    java.lang.String uuid, long companyId)
219                    throws com.liferay.portal.kernel.exception.PortalException,
220                            com.liferay.portal.kernel.exception.SystemException;
221    
222            /**
223            * Returns a range of all the announcements entries.
224            *
225            * <p>
226            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.announcements.model.impl.AnnouncementsEntryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
227            * </p>
228            *
229            * @param start the lower bound of the range of announcements entries
230            * @param end the upper bound of the range of announcements entries (not inclusive)
231            * @return the range of announcements entries
232            * @throws SystemException if a system exception occurred
233            */
234            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
235            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getAnnouncementsEntries(
236                    int start, int end)
237                    throws com.liferay.portal.kernel.exception.SystemException;
238    
239            /**
240            * Returns the number of announcements entries.
241            *
242            * @return the number of announcements entries
243            * @throws SystemException if a system exception occurred
244            */
245            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
246            public int getAnnouncementsEntriesCount()
247                    throws com.liferay.portal.kernel.exception.SystemException;
248    
249            /**
250            * Updates the announcements entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
251            *
252            * @param announcementsEntry the announcements entry
253            * @return the announcements entry that was updated
254            * @throws SystemException if a system exception occurred
255            */
256            public com.liferay.portlet.announcements.model.AnnouncementsEntry updateAnnouncementsEntry(
257                    com.liferay.portlet.announcements.model.AnnouncementsEntry announcementsEntry)
258                    throws com.liferay.portal.kernel.exception.SystemException;
259    
260            /**
261            * Returns the Spring bean ID for this bean.
262            *
263            * @return the Spring bean ID for this bean
264            */
265            public java.lang.String getBeanIdentifier();
266    
267            /**
268            * Sets the Spring bean ID for this bean.
269            *
270            * @param beanIdentifier the Spring bean ID for this bean
271            */
272            public void setBeanIdentifier(java.lang.String beanIdentifier);
273    
274            public com.liferay.portlet.announcements.model.AnnouncementsEntry addEntry(
275                    long userId, long classNameId, long classPK, java.lang.String title,
276                    java.lang.String content, java.lang.String url, java.lang.String type,
277                    int displayDateMonth, int displayDateDay, int displayDateYear,
278                    int displayDateHour, int displayDateMinute, boolean displayImmediately,
279                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
280                    int expirationDateHour, int expirationDateMinute, int priority,
281                    boolean alert)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException;
284    
285            /**
286            * @deprecated As of 6.2.0, replaced by {@link #addEntry(long, long, long,
287            String, String, String, String, int, int, int, int, int,
288            boolean, int, int, int, int, int, int, boolean)}
289            */
290            public com.liferay.portlet.announcements.model.AnnouncementsEntry addEntry(
291                    long userId, long classNameId, long classPK, java.lang.String title,
292                    java.lang.String content, java.lang.String url, java.lang.String type,
293                    int displayDateMonth, int displayDateDay, int displayDateYear,
294                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
295                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
296                    int expirationDateMinute, int priority, boolean alert)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException;
299    
300            public void checkEntries()
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException;
303    
304            public void deleteEntry(
305                    com.liferay.portlet.announcements.model.AnnouncementsEntry entry)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException;
308    
309            public void deleteEntry(long entryId)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException;
312    
313            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
314            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
315                    long userId, java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
316                    boolean alert, int flagValue, int start, int end)
317                    throws com.liferay.portal.kernel.exception.SystemException;
318    
319            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
320            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
321                    long userId, java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
322                    int displayDateMonth, int displayDateDay, int displayDateYear,
323                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
324                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
325                    int expirationDateMinute, boolean alert, int flagValue, int start,
326                    int end) throws com.liferay.portal.kernel.exception.SystemException;
327    
328            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
329            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
330                    long classNameId, long classPK, boolean alert, int start, int end)
331                    throws com.liferay.portal.kernel.exception.SystemException;
332    
333            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
334            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getEntries(
335                    long userId, long classNameId, long[] classPKs, int displayDateMonth,
336                    int displayDateDay, int displayDateYear, int displayDateHour,
337                    int displayDateMinute, int expirationDateMonth, int expirationDateDay,
338                    int expirationDateYear, int expirationDateHour,
339                    int expirationDateMinute, boolean alert, int flagValue, int start,
340                    int end) throws com.liferay.portal.kernel.exception.SystemException;
341    
342            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
343            public int getEntriesCount(long userId,
344                    java.util.LinkedHashMap<java.lang.Long, long[]> scopes, boolean alert,
345                    int flagValue)
346                    throws com.liferay.portal.kernel.exception.SystemException;
347    
348            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
349            public int getEntriesCount(long userId,
350                    java.util.LinkedHashMap<java.lang.Long, long[]> scopes,
351                    int displayDateMonth, int displayDateDay, int displayDateYear,
352                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
353                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
354                    int expirationDateMinute, boolean alert, int flagValue)
355                    throws com.liferay.portal.kernel.exception.SystemException;
356    
357            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
358            public int getEntriesCount(long classNameId, long classPK, boolean alert)
359                    throws com.liferay.portal.kernel.exception.SystemException;
360    
361            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
362            public int getEntriesCount(long userId, long classNameId, long[] classPKs,
363                    boolean alert, int flagValue)
364                    throws com.liferay.portal.kernel.exception.SystemException;
365    
366            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
367            public int getEntriesCount(long userId, long classNameId, long[] classPKs,
368                    int displayDateMonth, int displayDateDay, int displayDateYear,
369                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
370                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
371                    int expirationDateMinute, boolean alert, int flagValue)
372                    throws com.liferay.portal.kernel.exception.SystemException;
373    
374            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
375            public com.liferay.portlet.announcements.model.AnnouncementsEntry getEntry(
376                    long entryId)
377                    throws com.liferay.portal.kernel.exception.PortalException,
378                            com.liferay.portal.kernel.exception.SystemException;
379    
380            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
381            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsEntry> getUserEntries(
382                    long userId, int start, int end)
383                    throws com.liferay.portal.kernel.exception.SystemException;
384    
385            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
386            public int getUserEntriesCount(long userId)
387                    throws com.liferay.portal.kernel.exception.SystemException;
388    
389            public com.liferay.portlet.announcements.model.AnnouncementsEntry updateEntry(
390                    long userId, long entryId, java.lang.String title,
391                    java.lang.String content, java.lang.String url, java.lang.String type,
392                    int displayDateMonth, int displayDateDay, int displayDateYear,
393                    int displayDateHour, int displayDateMinute, int expirationDateMonth,
394                    int expirationDateDay, int expirationDateYear, int expirationDateHour,
395                    int expirationDateMinute, int priority)
396                    throws com.liferay.portal.kernel.exception.PortalException,
397                            com.liferay.portal.kernel.exception.SystemException;
398    }