001    /**
002     * Copyright (c) 2000-2010 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    
019    /**
020     * 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.
021     *
022     * <p>
023     * 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.
024     * </p>
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see PollsQuestionLocalService
032     * @see com.liferay.portlet.polls.service.base.PollsQuestionLocalServiceBaseImpl
033     * @see com.liferay.portlet.polls.service.impl.PollsQuestionLocalServiceImpl
034     * @generated
035     */
036    public class PollsQuestionLocalServiceUtil {
037            /**
038            * Adds the polls question to the database. Also notifies the appropriate model listeners.
039            *
040            * @param pollsQuestion the polls question to add
041            * @return the polls question that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portlet.polls.model.PollsQuestion addPollsQuestion(
045                    com.liferay.portlet.polls.model.PollsQuestion pollsQuestion)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addPollsQuestion(pollsQuestion);
048            }
049    
050            /**
051            * Creates a new polls question with the primary key. Does not add the polls question to the database.
052            *
053            * @param questionId the primary key for the new polls question
054            * @return the new polls question
055            */
056            public static com.liferay.portlet.polls.model.PollsQuestion createPollsQuestion(
057                    long questionId) {
058                    return getService().createPollsQuestion(questionId);
059            }
060    
061            /**
062            * Deletes the polls question with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param questionId the primary key of the polls question to delete
065            * @throws PortalException if a polls question with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deletePollsQuestion(long questionId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deletePollsQuestion(questionId);
072            }
073    
074            /**
075            * Deletes the polls question from the database. Also notifies the appropriate model listeners.
076            *
077            * @param pollsQuestion the polls question to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deletePollsQuestion(
081                    com.liferay.portlet.polls.model.PollsQuestion pollsQuestion)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deletePollsQuestion(pollsQuestion);
084            }
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query to search with
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public static java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException {
097                    return getService().dynamicQuery(dynamicQuery);
098            }
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 to search with
108            * @param start the lower bound of the range of model instances to return
109            * @param end the upper bound of the range of model instances to return (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public static 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                    return getService().dynamicQuery(dynamicQuery, start, end);
118            }
119    
120            /**
121            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
122            *
123            * <p>
124            * 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.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query to search with
128            * @param start the lower bound of the range of model instances to return
129            * @param end the upper bound of the range of model instances to return (not inclusive)
130            * @param orderByComparator the comparator to order the results by
131            * @return the ordered range of matching rows
132            * @throws SystemException if a system exception occurred
133            */
134            @SuppressWarnings("rawtypes")
135            public static java.util.List dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
137                    int end,
138                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
139                    throws com.liferay.portal.kernel.exception.SystemException {
140                    return getService()
141                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
142            }
143    
144            /**
145            * Counts the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query to search with
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public static long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().dynamicQueryCount(dynamicQuery);
155            }
156    
157            /**
158            * Gets the polls question with the primary key.
159            *
160            * @param questionId the primary key of the polls question to get
161            * @return the polls question
162            * @throws PortalException if a polls question with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portlet.polls.model.PollsQuestion getPollsQuestion(
166                    long questionId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getPollsQuestion(questionId);
170            }
171    
172            /**
173            * Gets the polls question with the UUID and group id.
174            *
175            * @param uuid the UUID of polls question to get
176            * @param groupId the group id of the polls question to get
177            * @return the polls question
178            * @throws PortalException if a polls question with the UUID and group id could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.polls.model.PollsQuestion getPollsQuestionByUuidAndGroupId(
182                    java.lang.String uuid, long groupId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getPollsQuestionByUuidAndGroupId(uuid, groupId);
186            }
187    
188            /**
189            * Gets a range of all the polls questions.
190            *
191            * <p>
192            * 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.
193            * </p>
194            *
195            * @param start the lower bound of the range of polls questions to return
196            * @param end the upper bound of the range of polls questions to return (not inclusive)
197            * @return the range of polls questions
198            * @throws SystemException if a system exception occurred
199            */
200            public static java.util.List<com.liferay.portlet.polls.model.PollsQuestion> getPollsQuestions(
201                    int start, int end)
202                    throws com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getPollsQuestions(start, end);
204            }
205    
206            /**
207            * Gets the number of polls questions.
208            *
209            * @return the number of polls questions
210            * @throws SystemException if a system exception occurred
211            */
212            public static int getPollsQuestionsCount()
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getPollsQuestionsCount();
215            }
216    
217            /**
218            * Updates the polls question in the database. Also notifies the appropriate model listeners.
219            *
220            * @param pollsQuestion the polls question to update
221            * @return the polls question that was updated
222            * @throws SystemException if a system exception occurred
223            */
224            public static com.liferay.portlet.polls.model.PollsQuestion updatePollsQuestion(
225                    com.liferay.portlet.polls.model.PollsQuestion pollsQuestion)
226                    throws com.liferay.portal.kernel.exception.SystemException {
227                    return getService().updatePollsQuestion(pollsQuestion);
228            }
229    
230            /**
231            * Updates the polls question in the database. Also notifies the appropriate model listeners.
232            *
233            * @param pollsQuestion the polls question to update
234            * @param merge whether to merge the polls question 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.
235            * @return the polls question that was updated
236            * @throws SystemException if a system exception occurred
237            */
238            public static com.liferay.portlet.polls.model.PollsQuestion updatePollsQuestion(
239                    com.liferay.portlet.polls.model.PollsQuestion pollsQuestion,
240                    boolean merge)
241                    throws com.liferay.portal.kernel.exception.SystemException {
242                    return getService().updatePollsQuestion(pollsQuestion, merge);
243            }
244    
245            public static com.liferay.portlet.polls.model.PollsQuestion addQuestion(
246                    long userId,
247                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
248                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
249                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
250                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
251                    java.util.List<com.liferay.portlet.polls.model.PollsChoice> choices,
252                    com.liferay.portal.service.ServiceContext serviceContext)
253                    throws com.liferay.portal.kernel.exception.PortalException,
254                            com.liferay.portal.kernel.exception.SystemException {
255                    return getService()
256                                       .addQuestion(userId, titleMap, descriptionMap,
257                            expirationDateMonth, expirationDateDay, expirationDateYear,
258                            expirationDateHour, expirationDateMinute, neverExpire, choices,
259                            serviceContext);
260            }
261    
262            public static void addQuestionResources(long questionId,
263                    boolean addCommunityPermissions, boolean addGuestPermissions)
264                    throws com.liferay.portal.kernel.exception.PortalException,
265                            com.liferay.portal.kernel.exception.SystemException {
266                    getService()
267                            .addQuestionResources(questionId, addCommunityPermissions,
268                            addGuestPermissions);
269            }
270    
271            public static void addQuestionResources(long questionId,
272                    java.lang.String[] communityPermissions,
273                    java.lang.String[] guestPermissions)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException {
276                    getService()
277                            .addQuestionResources(questionId, communityPermissions,
278                            guestPermissions);
279            }
280    
281            public static void addQuestionResources(
282                    com.liferay.portlet.polls.model.PollsQuestion question,
283                    boolean addCommunityPermissions, boolean addGuestPermissions)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException {
286                    getService()
287                            .addQuestionResources(question, addCommunityPermissions,
288                            addGuestPermissions);
289            }
290    
291            public static void addQuestionResources(
292                    com.liferay.portlet.polls.model.PollsQuestion question,
293                    java.lang.String[] communityPermissions,
294                    java.lang.String[] guestPermissions)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException {
297                    getService()
298                            .addQuestionResources(question, communityPermissions,
299                            guestPermissions);
300            }
301    
302            public static void deleteQuestion(long questionId)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    getService().deleteQuestion(questionId);
306            }
307    
308            public static void deleteQuestion(
309                    com.liferay.portlet.polls.model.PollsQuestion question)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException {
312                    getService().deleteQuestion(question);
313            }
314    
315            public static void deleteQuestions(long groupId)
316                    throws com.liferay.portal.kernel.exception.PortalException,
317                            com.liferay.portal.kernel.exception.SystemException {
318                    getService().deleteQuestions(groupId);
319            }
320    
321            public static com.liferay.portlet.polls.model.PollsQuestion getQuestion(
322                    long questionId)
323                    throws com.liferay.portal.kernel.exception.PortalException,
324                            com.liferay.portal.kernel.exception.SystemException {
325                    return getService().getQuestion(questionId);
326            }
327    
328            public static java.util.List<com.liferay.portlet.polls.model.PollsQuestion> getQuestions(
329                    long groupId)
330                    throws com.liferay.portal.kernel.exception.SystemException {
331                    return getService().getQuestions(groupId);
332            }
333    
334            public static java.util.List<com.liferay.portlet.polls.model.PollsQuestion> getQuestions(
335                    long groupId, int start, int end)
336                    throws com.liferay.portal.kernel.exception.SystemException {
337                    return getService().getQuestions(groupId, start, end);
338            }
339    
340            public static int getQuestionsCount(long groupId)
341                    throws com.liferay.portal.kernel.exception.SystemException {
342                    return getService().getQuestionsCount(groupId);
343            }
344    
345            public static com.liferay.portlet.polls.model.PollsQuestion updateQuestion(
346                    long userId, long questionId,
347                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
348                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
349                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
350                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
351                    java.util.List<com.liferay.portlet.polls.model.PollsChoice> choices,
352                    com.liferay.portal.service.ServiceContext serviceContext)
353                    throws com.liferay.portal.kernel.exception.PortalException,
354                            com.liferay.portal.kernel.exception.SystemException {
355                    return getService()
356                                       .updateQuestion(userId, questionId, titleMap,
357                            descriptionMap, expirationDateMonth, expirationDateDay,
358                            expirationDateYear, expirationDateHour, expirationDateMinute,
359                            neverExpire, choices, serviceContext);
360            }
361    
362            public static PollsQuestionLocalService getService() {
363                    if (_service == null) {
364                            _service = (PollsQuestionLocalService)PortalBeanLocatorUtil.locate(PollsQuestionLocalService.class.getName());
365                    }
366    
367                    return _service;
368            }
369    
370            public void setService(PollsQuestionLocalService service) {
371                    _service = service;
372            }
373    
374            private static PollsQuestionLocalService _service;
375    }