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