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.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.ReferenceRegistry;
019    
020    /**
021     * The utility for the announcements flag local service. This utility wraps {@link com.liferay.portlet.announcements.service.impl.AnnouncementsFlagLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
022     *
023     * <p>
024     * 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.
025     * </p>
026     *
027     * @author Brian Wing Shun Chan
028     * @see AnnouncementsFlagLocalService
029     * @see com.liferay.portlet.announcements.service.base.AnnouncementsFlagLocalServiceBaseImpl
030     * @see com.liferay.portlet.announcements.service.impl.AnnouncementsFlagLocalServiceImpl
031     * @generated
032     */
033    public class AnnouncementsFlagLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.announcements.service.impl.AnnouncementsFlagLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the announcements flag to the database. Also notifies the appropriate model listeners.
042            *
043            * @param announcementsFlag the announcements flag
044            * @return the announcements flag that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.announcements.model.AnnouncementsFlag addAnnouncementsFlag(
048                    com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addAnnouncementsFlag(announcementsFlag);
051            }
052    
053            /**
054            * Creates a new announcements flag with the primary key. Does not add the announcements flag to the database.
055            *
056            * @param flagId the primary key for the new announcements flag
057            * @return the new announcements flag
058            */
059            public static com.liferay.portlet.announcements.model.AnnouncementsFlag createAnnouncementsFlag(
060                    long flagId) {
061                    return getService().createAnnouncementsFlag(flagId);
062            }
063    
064            /**
065            * Deletes the announcements flag with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param flagId the primary key of the announcements flag
068            * @return the announcements flag that was removed
069            * @throws PortalException if a announcements flag with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portlet.announcements.model.AnnouncementsFlag deleteAnnouncementsFlag(
073                    long flagId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteAnnouncementsFlag(flagId);
077            }
078    
079            /**
080            * Deletes the announcements flag from the database. Also notifies the appropriate model listeners.
081            *
082            * @param announcementsFlag the announcements flag
083            * @return the announcements flag that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.announcements.model.AnnouncementsFlag deleteAnnouncementsFlag(
087                    com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteAnnouncementsFlag(announcementsFlag);
090            }
091    
092            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
093                    return getService().dynamicQuery();
094            }
095    
096            /**
097            * Performs a dynamic query on the database and returns the matching rows.
098            *
099            * @param dynamicQuery the dynamic query
100            * @return the matching rows
101            * @throws SystemException if a system exception occurred
102            */
103            @SuppressWarnings("rawtypes")
104            public static java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException {
107                    return getService().dynamicQuery(dynamicQuery);
108            }
109    
110            /**
111            * Performs a dynamic query on the database and returns a range of the matching rows.
112            *
113            * <p>
114            * 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.AnnouncementsFlagModelImpl}. 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.
115            * </p>
116            *
117            * @param dynamicQuery the dynamic query
118            * @param start the lower bound of the range of model instances
119            * @param end the upper bound of the range of model instances (not inclusive)
120            * @return the range of matching rows
121            * @throws SystemException if a system exception occurred
122            */
123            @SuppressWarnings("rawtypes")
124            public static java.util.List dynamicQuery(
125                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
126                    int end) throws com.liferay.portal.kernel.exception.SystemException {
127                    return getService().dynamicQuery(dynamicQuery, start, end);
128            }
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.AnnouncementsFlagModelImpl}. 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 static 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                    return getService()
151                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
152            }
153    
154            /**
155            * Returns the number of rows that match the dynamic query.
156            *
157            * @param dynamicQuery the dynamic query
158            * @return the number of rows that match the dynamic query
159            * @throws SystemException if a system exception occurred
160            */
161            public static long dynamicQueryCount(
162                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().dynamicQueryCount(dynamicQuery);
165            }
166    
167            public static com.liferay.portlet.announcements.model.AnnouncementsFlag fetchAnnouncementsFlag(
168                    long flagId) throws com.liferay.portal.kernel.exception.SystemException {
169                    return getService().fetchAnnouncementsFlag(flagId);
170            }
171    
172            /**
173            * Returns the announcements flag with the primary key.
174            *
175            * @param flagId the primary key of the announcements flag
176            * @return the announcements flag
177            * @throws PortalException if a announcements flag with the primary key could not be found
178            * @throws SystemException if a system exception occurred
179            */
180            public static com.liferay.portlet.announcements.model.AnnouncementsFlag getAnnouncementsFlag(
181                    long flagId)
182                    throws com.liferay.portal.kernel.exception.PortalException,
183                            com.liferay.portal.kernel.exception.SystemException {
184                    return getService().getAnnouncementsFlag(flagId);
185            }
186    
187            public static com.liferay.portal.model.PersistedModel getPersistedModel(
188                    java.io.Serializable primaryKeyObj)
189                    throws com.liferay.portal.kernel.exception.PortalException,
190                            com.liferay.portal.kernel.exception.SystemException {
191                    return getService().getPersistedModel(primaryKeyObj);
192            }
193    
194            /**
195            * Returns a range of all the announcements flags.
196            *
197            * <p>
198            * 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.AnnouncementsFlagModelImpl}. 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.
199            * </p>
200            *
201            * @param start the lower bound of the range of announcements flags
202            * @param end the upper bound of the range of announcements flags (not inclusive)
203            * @return the range of announcements flags
204            * @throws SystemException if a system exception occurred
205            */
206            public static java.util.List<com.liferay.portlet.announcements.model.AnnouncementsFlag> getAnnouncementsFlags(
207                    int start, int end)
208                    throws com.liferay.portal.kernel.exception.SystemException {
209                    return getService().getAnnouncementsFlags(start, end);
210            }
211    
212            /**
213            * Returns the number of announcements flags.
214            *
215            * @return the number of announcements flags
216            * @throws SystemException if a system exception occurred
217            */
218            public static int getAnnouncementsFlagsCount()
219                    throws com.liferay.portal.kernel.exception.SystemException {
220                    return getService().getAnnouncementsFlagsCount();
221            }
222    
223            /**
224            * Updates the announcements flag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
225            *
226            * @param announcementsFlag the announcements flag
227            * @return the announcements flag that was updated
228            * @throws SystemException if a system exception occurred
229            */
230            public static com.liferay.portlet.announcements.model.AnnouncementsFlag updateAnnouncementsFlag(
231                    com.liferay.portlet.announcements.model.AnnouncementsFlag announcementsFlag)
232                    throws com.liferay.portal.kernel.exception.SystemException {
233                    return getService().updateAnnouncementsFlag(announcementsFlag);
234            }
235    
236            /**
237            * Returns the Spring bean ID for this bean.
238            *
239            * @return the Spring bean ID for this bean
240            */
241            public static java.lang.String getBeanIdentifier() {
242                    return getService().getBeanIdentifier();
243            }
244    
245            /**
246            * Sets the Spring bean ID for this bean.
247            *
248            * @param beanIdentifier the Spring bean ID for this bean
249            */
250            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
251                    getService().setBeanIdentifier(beanIdentifier);
252            }
253    
254            public static com.liferay.portlet.announcements.model.AnnouncementsFlag addFlag(
255                    long userId, long entryId, int value)
256                    throws com.liferay.portal.kernel.exception.SystemException {
257                    return getService().addFlag(userId, entryId, value);
258            }
259    
260            public static void deleteFlag(
261                    com.liferay.portlet.announcements.model.AnnouncementsFlag flag)
262                    throws com.liferay.portal.kernel.exception.SystemException {
263                    getService().deleteFlag(flag);
264            }
265    
266            public static void deleteFlag(long flagId)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException {
269                    getService().deleteFlag(flagId);
270            }
271    
272            public static void deleteFlags(long entryId)
273                    throws com.liferay.portal.kernel.exception.SystemException {
274                    getService().deleteFlags(entryId);
275            }
276    
277            public static com.liferay.portlet.announcements.model.AnnouncementsFlag getFlag(
278                    long userId, long entryId, int value)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException {
281                    return getService().getFlag(userId, entryId, value);
282            }
283    
284            public static AnnouncementsFlagLocalService getService() {
285                    if (_service == null) {
286                            _service = (AnnouncementsFlagLocalService)PortalBeanLocatorUtil.locate(AnnouncementsFlagLocalService.class.getName());
287    
288                            ReferenceRegistry.registerReference(AnnouncementsFlagLocalServiceUtil.class,
289                                    "_service");
290                    }
291    
292                    return _service;
293            }
294    
295            /**
296             * @deprecated
297             */
298            public void setService(AnnouncementsFlagLocalService service) {
299            }
300    
301            private static AnnouncementsFlagLocalService _service;
302    }