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 flag 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 AnnouncementsFlagLocalServiceUtil
033     * @see com.liferay.portlet.announcements.service.base.AnnouncementsFlagLocalServiceBaseImpl
034     * @see com.liferay.portlet.announcements.service.impl.AnnouncementsFlagLocalServiceImpl
035     * @generated
036     */
037    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
038            PortalException.class, SystemException.class})
039    public interface AnnouncementsFlagLocalService
040            extends PersistedModelLocalService {
041            /*
042             * NOTE FOR DEVELOPERS:
043             *
044             * Never modify or reference this interface directly. Always use {@link AnnouncementsFlagLocalServiceUtil} to access the announcements flag local service. Add custom service methods to {@link com.liferay.portlet.announcements.service.impl.AnnouncementsFlagLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
045             */
046    
047            /**
048            * Adds the announcements flag to the database. Also notifies the appropriate model listeners.
049            *
050            * @param announcementsFlag the announcements flag
051            * @return the announcements flag that was added
052            * @throws SystemException if a system exception occurred
053            */
054            public com.liferay.portlet.announcements.model.AnnouncementsFlag addAnnouncementsFlag(
055                    com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag)
056                    throws com.liferay.portal.kernel.exception.SystemException;
057    
058            /**
059            * Creates a new announcements flag with the primary key. Does not add the announcements flag to the database.
060            *
061            * @param flagId the primary key for the new announcements flag
062            * @return the new announcements flag
063            */
064            public com.liferay.portlet.announcements.model.AnnouncementsFlag createAnnouncementsFlag(
065                    long flagId);
066    
067            /**
068            * Deletes the announcements flag with the primary key from the database. Also notifies the appropriate model listeners.
069            *
070            * @param flagId the primary key of the announcements flag
071            * @throws PortalException if a announcements flag with the primary key could not be found
072            * @throws SystemException if a system exception occurred
073            */
074            public void deleteAnnouncementsFlag(long flagId)
075                    throws com.liferay.portal.kernel.exception.PortalException,
076                            com.liferay.portal.kernel.exception.SystemException;
077    
078            /**
079            * Deletes the announcements flag from the database. Also notifies the appropriate model listeners.
080            *
081            * @param announcementsFlag the announcements flag
082            * @throws SystemException if a system exception occurred
083            */
084            public void deleteAnnouncementsFlag(
085                    com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag)
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.AnnouncementsFlag fetchAnnouncementsFlag(
152                    long flagId) throws com.liferay.portal.kernel.exception.SystemException;
153    
154            /**
155            * Returns the announcements flag with the primary key.
156            *
157            * @param flagId the primary key of the announcements flag
158            * @return the announcements flag
159            * @throws PortalException if a announcements flag with the primary key could not be found
160            * @throws SystemException if a system exception occurred
161            */
162            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
163            public com.liferay.portlet.announcements.model.AnnouncementsFlag getAnnouncementsFlag(
164                    long flagId)
165                    throws com.liferay.portal.kernel.exception.PortalException,
166                            com.liferay.portal.kernel.exception.SystemException;
167    
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portal.model.PersistedModel getPersistedModel(
170                    java.io.Serializable primaryKeyObj)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException;
173    
174            /**
175            * Returns a range of all the announcements flags.
176            *
177            * <p>
178            * 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.
179            * </p>
180            *
181            * @param start the lower bound of the range of announcements flags
182            * @param end the upper bound of the range of announcements flags (not inclusive)
183            * @return the range of announcements flags
184            * @throws SystemException if a system exception occurred
185            */
186            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
187            public java.util.List<com.liferay.portlet.announcements.model.AnnouncementsFlag> getAnnouncementsFlags(
188                    int start, int end)
189                    throws com.liferay.portal.kernel.exception.SystemException;
190    
191            /**
192            * Returns the number of announcements flags.
193            *
194            * @return the number of announcements flags
195            * @throws SystemException if a system exception occurred
196            */
197            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
198            public int getAnnouncementsFlagsCount()
199                    throws com.liferay.portal.kernel.exception.SystemException;
200    
201            /**
202            * Updates the announcements flag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
203            *
204            * @param announcementsFlag the announcements flag
205            * @return the announcements flag that was updated
206            * @throws SystemException if a system exception occurred
207            */
208            public com.liferay.portlet.announcements.model.AnnouncementsFlag updateAnnouncementsFlag(
209                    com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag)
210                    throws com.liferay.portal.kernel.exception.SystemException;
211    
212            /**
213            * Updates the announcements flag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param announcementsFlag the announcements flag
216            * @param merge whether to merge the announcements flag 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.
217            * @return the announcements flag that was updated
218            * @throws SystemException if a system exception occurred
219            */
220            public com.liferay.portlet.announcements.model.AnnouncementsFlag updateAnnouncementsFlag(
221                    com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag,
222                    boolean merge)
223                    throws com.liferay.portal.kernel.exception.SystemException;
224    
225            /**
226            * Returns the Spring bean ID for this bean.
227            *
228            * @return the Spring bean ID for this bean
229            */
230            public java.lang.String getBeanIdentifier();
231    
232            /**
233            * Sets the Spring bean ID for this bean.
234            *
235            * @param beanIdentifier the Spring bean ID for this bean
236            */
237            public void setBeanIdentifier(java.lang.String beanIdentifier);
238    
239            public com.liferay.portlet.announcements.model.AnnouncementsFlag addFlag(
240                    long userId, long entryId, int value)
241                    throws com.liferay.portal.kernel.exception.SystemException;
242    
243            public void deleteFlag(
244                    com.liferay.portlet.announcements.model.AnnouncementsFlag flag)
245                    throws com.liferay.portal.kernel.exception.SystemException;
246    
247            public void deleteFlag(long flagId)
248                    throws com.liferay.portal.kernel.exception.PortalException,
249                            com.liferay.portal.kernel.exception.SystemException;
250    
251            public void deleteFlags(long entryId)
252                    throws com.liferay.portal.kernel.exception.SystemException;
253    
254            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
255            public com.liferay.portlet.announcements.model.AnnouncementsFlag getFlag(
256                    long userId, long entryId, int value)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException;
259    }