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.polls.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 polls question local service. This utility wraps {@link com.liferay.portlet.polls.service.impl.PollsQuestionLocalServiceImpl} 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 PollsQuestionLocalService
029     * @see com.liferay.portlet.polls.service.base.PollsQuestionLocalServiceBaseImpl
030     * @see com.liferay.portlet.polls.service.impl.PollsQuestionLocalServiceImpl
031     * @generated
032     */
033    public class PollsQuestionLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.polls.service.impl.PollsQuestionLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the polls question to the database. Also notifies the appropriate model listeners.
042            *
043            * @param pollsQuestion the polls question
044            * @return the polls question that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.polls.model.PollsQuestion addPollsQuestion(
048                    com.liferay.portlet.polls.model.PollsQuestion pollsQuestion)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addPollsQuestion(pollsQuestion);
051            }
052    
053            /**
054            * Creates a new polls question with the primary key. Does not add the polls question to the database.
055            *
056            * @param questionId the primary key for the new polls question
057            * @return the new polls question
058            */
059            public static com.liferay.portlet.polls.model.PollsQuestion createPollsQuestion(
060                    long questionId) {
061                    return getService().createPollsQuestion(questionId);
062            }
063    
064            /**
065            * Deletes the polls question with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param questionId the primary key of the polls question
068            * @return the polls question that was removed
069            * @throws PortalException if a polls question with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portlet.polls.model.PollsQuestion deletePollsQuestion(
073                    long questionId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deletePollsQuestion(questionId);
077            }
078    
079            /**
080            * Deletes the polls question from the database. Also notifies the appropriate model listeners.
081            *
082            * @param pollsQuestion the polls question
083            * @return the polls question that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.polls.model.PollsQuestion deletePollsQuestion(
087                    com.liferay.portlet.polls.model.PollsQuestion pollsQuestion)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deletePollsQuestion(pollsQuestion);
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.polls.model.impl.PollsQuestionModelImpl}. 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.polls.model.impl.PollsQuestionModelImpl}. 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.polls.model.PollsQuestion fetchPollsQuestion(
168                    long questionId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchPollsQuestion(questionId);
171            }
172    
173            /**
174            * Returns the polls question with the primary key.
175            *
176            * @param questionId the primary key of the polls question
177            * @return the polls question
178            * @throws PortalException if a polls question with the primary key could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.polls.model.PollsQuestion getPollsQuestion(
182                    long questionId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getPollsQuestion(questionId);
186            }
187    
188            public static com.liferay.portal.model.PersistedModel getPersistedModel(
189                    java.io.Serializable primaryKeyObj)
190                    throws com.liferay.portal.kernel.exception.PortalException,
191                            com.liferay.portal.kernel.exception.SystemException {
192                    return getService().getPersistedModel(primaryKeyObj);
193            }
194    
195            /**
196            * Returns the polls question matching the UUID and group.
197            *
198            * @param uuid the polls question's UUID
199            * @param groupId the primary key of the group
200            * @return the matching polls question
201            * @throws PortalException if a matching polls question could not be found
202            * @throws SystemException if a system exception occurred
203            */
204            public static com.liferay.portlet.polls.model.PollsQuestion getPollsQuestionByUuidAndGroupId(
205                    java.lang.String uuid, long groupId)
206                    throws com.liferay.portal.kernel.exception.PortalException,
207                            com.liferay.portal.kernel.exception.SystemException {
208                    return getService().getPollsQuestionByUuidAndGroupId(uuid, groupId);
209            }
210    
211            /**
212            * Returns a range of all the polls questions.
213            *
214            * <p>
215            * 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.polls.model.impl.PollsQuestionModelImpl}. 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.
216            * </p>
217            *
218            * @param start the lower bound of the range of polls questions
219            * @param end the upper bound of the range of polls questions (not inclusive)
220            * @return the range of polls questions
221            * @throws SystemException if a system exception occurred
222            */
223            public static java.util.List<com.liferay.portlet.polls.model.PollsQuestion> getPollsQuestions(
224                    int start, int end)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().getPollsQuestions(start, end);
227            }
228    
229            /**
230            * Returns the number of polls questions.
231            *
232            * @return the number of polls questions
233            * @throws SystemException if a system exception occurred
234            */
235            public static int getPollsQuestionsCount()
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().getPollsQuestionsCount();
238            }
239    
240            /**
241            * Updates the polls question in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
242            *
243            * @param pollsQuestion the polls question
244            * @return the polls question that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portlet.polls.model.PollsQuestion updatePollsQuestion(
248                    com.liferay.portlet.polls.model.PollsQuestion pollsQuestion)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updatePollsQuestion(pollsQuestion);
251            }
252    
253            /**
254            * Returns the Spring bean ID for this bean.
255            *
256            * @return the Spring bean ID for this bean
257            */
258            public static java.lang.String getBeanIdentifier() {
259                    return getService().getBeanIdentifier();
260            }
261    
262            /**
263            * Sets the Spring bean ID for this bean.
264            *
265            * @param beanIdentifier the Spring bean ID for this bean
266            */
267            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
268                    getService().setBeanIdentifier(beanIdentifier);
269            }
270    
271            public static com.liferay.portlet.polls.model.PollsQuestion addQuestion(
272                    long userId,
273                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
274                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
275                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
276                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
277                    java.util.List<com.liferay.portlet.polls.model.PollsChoice> choices,
278                    com.liferay.portal.service.ServiceContext serviceContext)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException {
281                    return getService()
282                                       .addQuestion(userId, titleMap, descriptionMap,
283                            expirationDateMonth, expirationDateDay, expirationDateYear,
284                            expirationDateHour, expirationDateMinute, neverExpire, choices,
285                            serviceContext);
286            }
287    
288            public static void addQuestionResources(long questionId,
289                    boolean addGroupPermissions, boolean addGuestPermissions)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    getService()
293                            .addQuestionResources(questionId, addGroupPermissions,
294                            addGuestPermissions);
295            }
296    
297            public static void addQuestionResources(long questionId,
298                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException {
301                    getService()
302                            .addQuestionResources(questionId, groupPermissions, guestPermissions);
303            }
304    
305            public static void addQuestionResources(
306                    com.liferay.portlet.polls.model.PollsQuestion question,
307                    boolean addGroupPermissions, boolean addGuestPermissions)
308                    throws com.liferay.portal.kernel.exception.PortalException,
309                            com.liferay.portal.kernel.exception.SystemException {
310                    getService()
311                            .addQuestionResources(question, addGroupPermissions,
312                            addGuestPermissions);
313            }
314    
315            public static void addQuestionResources(
316                    com.liferay.portlet.polls.model.PollsQuestion question,
317                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException {
320                    getService()
321                            .addQuestionResources(question, groupPermissions, guestPermissions);
322            }
323    
324            public static void deleteQuestion(long questionId)
325                    throws com.liferay.portal.kernel.exception.PortalException,
326                            com.liferay.portal.kernel.exception.SystemException {
327                    getService().deleteQuestion(questionId);
328            }
329    
330            public static void deleteQuestion(
331                    com.liferay.portlet.polls.model.PollsQuestion question)
332                    throws com.liferay.portal.kernel.exception.PortalException,
333                            com.liferay.portal.kernel.exception.SystemException {
334                    getService().deleteQuestion(question);
335            }
336    
337            public static void deleteQuestions(long groupId)
338                    throws com.liferay.portal.kernel.exception.PortalException,
339                            com.liferay.portal.kernel.exception.SystemException {
340                    getService().deleteQuestions(groupId);
341            }
342    
343            public static com.liferay.portlet.polls.model.PollsQuestion getQuestion(
344                    long questionId)
345                    throws com.liferay.portal.kernel.exception.PortalException,
346                            com.liferay.portal.kernel.exception.SystemException {
347                    return getService().getQuestion(questionId);
348            }
349    
350            public static java.util.List<com.liferay.portlet.polls.model.PollsQuestion> getQuestions(
351                    long groupId)
352                    throws com.liferay.portal.kernel.exception.SystemException {
353                    return getService().getQuestions(groupId);
354            }
355    
356            public static java.util.List<com.liferay.portlet.polls.model.PollsQuestion> getQuestions(
357                    long groupId, int start, int end)
358                    throws com.liferay.portal.kernel.exception.SystemException {
359                    return getService().getQuestions(groupId, start, end);
360            }
361    
362            public static int getQuestionsCount(long groupId)
363                    throws com.liferay.portal.kernel.exception.SystemException {
364                    return getService().getQuestionsCount(groupId);
365            }
366    
367            public static com.liferay.portlet.polls.model.PollsQuestion updateQuestion(
368                    long userId, long questionId,
369                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
370                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
371                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
372                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
373                    java.util.List<com.liferay.portlet.polls.model.PollsChoice> choices,
374                    com.liferay.portal.service.ServiceContext serviceContext)
375                    throws com.liferay.portal.kernel.exception.PortalException,
376                            com.liferay.portal.kernel.exception.SystemException {
377                    return getService()
378                                       .updateQuestion(userId, questionId, titleMap,
379                            descriptionMap, expirationDateMonth, expirationDateDay,
380                            expirationDateYear, expirationDateHour, expirationDateMinute,
381                            neverExpire, choices, serviceContext);
382            }
383    
384            public static PollsQuestionLocalService getService() {
385                    if (_service == null) {
386                            _service = (PollsQuestionLocalService)PortalBeanLocatorUtil.locate(PollsQuestionLocalService.class.getName());
387    
388                            ReferenceRegistry.registerReference(PollsQuestionLocalServiceUtil.class,
389                                    "_service");
390                    }
391    
392                    return _service;
393            }
394    
395            /**
396             * @deprecated As of 6.2.0
397             */
398            public void setService(PollsQuestionLocalService service) {
399            }
400    
401            private static PollsQuestionLocalService _service;
402    }