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 aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
020    import com.liferay.portal.kernel.util.ReferenceRegistry;
021    
022    /**
023     * Provides the local service utility for PollsQuestion. This utility wraps
024     * {@link com.liferay.portlet.polls.service.impl.PollsQuestionLocalServiceImpl} and is the
025     * primary access point for service operations in application layer code running
026     * on the local server. Methods of this service will not have security checks
027     * based on the propagated JAAS credentials because this service can only be
028     * accessed from within the same VM.
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    @ProviderType
037    public class PollsQuestionLocalServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * 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.
042             */
043    
044            /**
045            * Adds the polls question to the database. Also notifies the appropriate model listeners.
046            *
047            * @param pollsQuestion the polls question
048            * @return the polls question that was added
049            * @throws SystemException if a system exception occurred
050            */
051            public static com.liferay.portlet.polls.model.PollsQuestion addPollsQuestion(
052                    com.liferay.portlet.polls.model.PollsQuestion pollsQuestion)
053                    throws com.liferay.portal.kernel.exception.SystemException {
054                    return getService().addPollsQuestion(pollsQuestion);
055            }
056    
057            /**
058            * Creates a new polls question with the primary key. Does not add the polls question to the database.
059            *
060            * @param questionId the primary key for the new polls question
061            * @return the new polls question
062            */
063            public static com.liferay.portlet.polls.model.PollsQuestion createPollsQuestion(
064                    long questionId) {
065                    return getService().createPollsQuestion(questionId);
066            }
067    
068            /**
069            * Deletes the polls question with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param questionId the primary key of the polls question
072            * @return the polls question that was removed
073            * @throws PortalException if a polls question with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public static com.liferay.portlet.polls.model.PollsQuestion deletePollsQuestion(
077                    long questionId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException {
080                    return getService().deletePollsQuestion(questionId);
081            }
082    
083            /**
084            * Deletes the polls question from the database. Also notifies the appropriate model listeners.
085            *
086            * @param pollsQuestion the polls question
087            * @return the polls question that was removed
088            * @throws SystemException if a system exception occurred
089            */
090            public static com.liferay.portlet.polls.model.PollsQuestion deletePollsQuestion(
091                    com.liferay.portlet.polls.model.PollsQuestion pollsQuestion)
092                    throws com.liferay.portal.kernel.exception.SystemException {
093                    return getService().deletePollsQuestion(pollsQuestion);
094            }
095    
096            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
097                    return getService().dynamicQuery();
098            }
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 static java.util.List dynamicQuery(
109                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
110                    throws com.liferay.portal.kernel.exception.SystemException {
111                    return getService().dynamicQuery(dynamicQuery);
112            }
113    
114            /**
115            * Performs a dynamic query on the database and returns a range of the matching rows.
116            *
117            * <p>
118            * 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query
122            * @param start the lower bound of the range of model instances
123            * @param end the upper bound of the range of model instances (not inclusive)
124            * @return the range of matching rows
125            * @throws SystemException if a system exception occurred
126            */
127            @SuppressWarnings("rawtypes")
128            public static java.util.List dynamicQuery(
129                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
130                    int end) throws com.liferay.portal.kernel.exception.SystemException {
131                    return getService().dynamicQuery(dynamicQuery, start, end);
132            }
133    
134            /**
135            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
136            *
137            * <p>
138            * 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.
139            * </p>
140            *
141            * @param dynamicQuery the dynamic query
142            * @param start the lower bound of the range of model instances
143            * @param end the upper bound of the range of model instances (not inclusive)
144            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
145            * @return the ordered range of matching rows
146            * @throws SystemException if a system exception occurred
147            */
148            @SuppressWarnings("rawtypes")
149            public static java.util.List dynamicQuery(
150                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
151                    int end,
152                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService()
155                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
156            }
157    
158            /**
159            * Returns the number of rows that match the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @return the number of rows that match the dynamic query
163            * @throws SystemException if a system exception occurred
164            */
165            public static long dynamicQueryCount(
166                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
167                    throws com.liferay.portal.kernel.exception.SystemException {
168                    return getService().dynamicQueryCount(dynamicQuery);
169            }
170    
171            /**
172            * Returns the number of rows that match the dynamic query.
173            *
174            * @param dynamicQuery the dynamic query
175            * @param projection the projection to apply to the query
176            * @return the number of rows that match the dynamic query
177            * @throws SystemException if a system exception occurred
178            */
179            public static long dynamicQueryCount(
180                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
181                    com.liferay.portal.kernel.dao.orm.Projection projection)
182                    throws com.liferay.portal.kernel.exception.SystemException {
183                    return getService().dynamicQueryCount(dynamicQuery, projection);
184            }
185    
186            public static com.liferay.portlet.polls.model.PollsQuestion fetchPollsQuestion(
187                    long questionId)
188                    throws com.liferay.portal.kernel.exception.SystemException {
189                    return getService().fetchPollsQuestion(questionId);
190            }
191    
192            /**
193            * Returns the polls question with the matching UUID and company.
194            *
195            * @param uuid the polls question's UUID
196            * @param companyId the primary key of the company
197            * @return the matching polls question, or <code>null</code> if a matching polls question could not be found
198            * @throws SystemException if a system exception occurred
199            */
200            public static com.liferay.portlet.polls.model.PollsQuestion fetchPollsQuestionByUuidAndCompanyId(
201                    java.lang.String uuid, long companyId)
202                    throws com.liferay.portal.kernel.exception.SystemException {
203                    return getService().fetchPollsQuestionByUuidAndCompanyId(uuid, companyId);
204            }
205    
206            /**
207            * Returns the polls question matching the UUID and group.
208            *
209            * @param uuid the polls question's UUID
210            * @param groupId the primary key of the group
211            * @return the matching polls question, or <code>null</code> if a matching polls question could not be found
212            * @throws SystemException if a system exception occurred
213            */
214            public static com.liferay.portlet.polls.model.PollsQuestion fetchPollsQuestionByUuidAndGroupId(
215                    java.lang.String uuid, long groupId)
216                    throws com.liferay.portal.kernel.exception.SystemException {
217                    return getService().fetchPollsQuestionByUuidAndGroupId(uuid, groupId);
218            }
219    
220            /**
221            * Returns the polls question with the primary key.
222            *
223            * @param questionId the primary key of the polls question
224            * @return the polls question
225            * @throws PortalException if a polls question with the primary key could not be found
226            * @throws SystemException if a system exception occurred
227            */
228            public static com.liferay.portlet.polls.model.PollsQuestion getPollsQuestion(
229                    long questionId)
230                    throws com.liferay.portal.kernel.exception.PortalException,
231                            com.liferay.portal.kernel.exception.SystemException {
232                    return getService().getPollsQuestion(questionId);
233            }
234    
235            public static com.liferay.portal.model.PersistedModel getPersistedModel(
236                    java.io.Serializable primaryKeyObj)
237                    throws com.liferay.portal.kernel.exception.PortalException,
238                            com.liferay.portal.kernel.exception.SystemException {
239                    return getService().getPersistedModel(primaryKeyObj);
240            }
241    
242            /**
243            * Returns the polls question with the matching UUID and company.
244            *
245            * @param uuid the polls question's UUID
246            * @param companyId the primary key of the company
247            * @return the matching polls question
248            * @throws PortalException if a matching polls question could not be found
249            * @throws SystemException if a system exception occurred
250            */
251            public static com.liferay.portlet.polls.model.PollsQuestion getPollsQuestionByUuidAndCompanyId(
252                    java.lang.String uuid, long companyId)
253                    throws com.liferay.portal.kernel.exception.PortalException,
254                            com.liferay.portal.kernel.exception.SystemException {
255                    return getService().getPollsQuestionByUuidAndCompanyId(uuid, companyId);
256            }
257    
258            /**
259            * Returns the polls question matching the UUID and group.
260            *
261            * @param uuid the polls question's UUID
262            * @param groupId the primary key of the group
263            * @return the matching polls question
264            * @throws PortalException if a matching polls question could not be found
265            * @throws SystemException if a system exception occurred
266            */
267            public static com.liferay.portlet.polls.model.PollsQuestion getPollsQuestionByUuidAndGroupId(
268                    java.lang.String uuid, long groupId)
269                    throws com.liferay.portal.kernel.exception.PortalException,
270                            com.liferay.portal.kernel.exception.SystemException {
271                    return getService().getPollsQuestionByUuidAndGroupId(uuid, groupId);
272            }
273    
274            /**
275            * Returns a range of all the polls questions.
276            *
277            * <p>
278            * 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.
279            * </p>
280            *
281            * @param start the lower bound of the range of polls questions
282            * @param end the upper bound of the range of polls questions (not inclusive)
283            * @return the range of polls questions
284            * @throws SystemException if a system exception occurred
285            */
286            public static java.util.List<com.liferay.portlet.polls.model.PollsQuestion> getPollsQuestions(
287                    int start, int end)
288                    throws com.liferay.portal.kernel.exception.SystemException {
289                    return getService().getPollsQuestions(start, end);
290            }
291    
292            /**
293            * Returns the number of polls questions.
294            *
295            * @return the number of polls questions
296            * @throws SystemException if a system exception occurred
297            */
298            public static int getPollsQuestionsCount()
299                    throws com.liferay.portal.kernel.exception.SystemException {
300                    return getService().getPollsQuestionsCount();
301            }
302    
303            /**
304            * Updates the polls question in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
305            *
306            * @param pollsQuestion the polls question
307            * @return the polls question that was updated
308            * @throws SystemException if a system exception occurred
309            */
310            public static com.liferay.portlet.polls.model.PollsQuestion updatePollsQuestion(
311                    com.liferay.portlet.polls.model.PollsQuestion pollsQuestion)
312                    throws com.liferay.portal.kernel.exception.SystemException {
313                    return getService().updatePollsQuestion(pollsQuestion);
314            }
315    
316            /**
317            * Returns the Spring bean ID for this bean.
318            *
319            * @return the Spring bean ID for this bean
320            */
321            public static java.lang.String getBeanIdentifier() {
322                    return getService().getBeanIdentifier();
323            }
324    
325            /**
326            * Sets the Spring bean ID for this bean.
327            *
328            * @param beanIdentifier the Spring bean ID for this bean
329            */
330            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
331                    getService().setBeanIdentifier(beanIdentifier);
332            }
333    
334            public static com.liferay.portlet.polls.model.PollsQuestion addQuestion(
335                    long userId,
336                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
337                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
338                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
339                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
340                    java.util.List<com.liferay.portlet.polls.model.PollsChoice> choices,
341                    com.liferay.portal.service.ServiceContext serviceContext)
342                    throws com.liferay.portal.kernel.exception.PortalException,
343                            com.liferay.portal.kernel.exception.SystemException {
344                    return getService()
345                                       .addQuestion(userId, titleMap, descriptionMap,
346                            expirationDateMonth, expirationDateDay, expirationDateYear,
347                            expirationDateHour, expirationDateMinute, neverExpire, choices,
348                            serviceContext);
349            }
350    
351            public static void addQuestionResources(long questionId,
352                    boolean addGroupPermissions, boolean addGuestPermissions)
353                    throws com.liferay.portal.kernel.exception.PortalException,
354                            com.liferay.portal.kernel.exception.SystemException {
355                    getService()
356                            .addQuestionResources(questionId, addGroupPermissions,
357                            addGuestPermissions);
358            }
359    
360            public static void addQuestionResources(long questionId,
361                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
362                    throws com.liferay.portal.kernel.exception.PortalException,
363                            com.liferay.portal.kernel.exception.SystemException {
364                    getService()
365                            .addQuestionResources(questionId, groupPermissions, guestPermissions);
366            }
367    
368            public static void addQuestionResources(
369                    com.liferay.portlet.polls.model.PollsQuestion question,
370                    boolean addGroupPermissions, boolean addGuestPermissions)
371                    throws com.liferay.portal.kernel.exception.PortalException,
372                            com.liferay.portal.kernel.exception.SystemException {
373                    getService()
374                            .addQuestionResources(question, addGroupPermissions,
375                            addGuestPermissions);
376            }
377    
378            public static void addQuestionResources(
379                    com.liferay.portlet.polls.model.PollsQuestion question,
380                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
381                    throws com.liferay.portal.kernel.exception.PortalException,
382                            com.liferay.portal.kernel.exception.SystemException {
383                    getService()
384                            .addQuestionResources(question, groupPermissions, guestPermissions);
385            }
386    
387            public static void deleteQuestion(long questionId)
388                    throws com.liferay.portal.kernel.exception.PortalException,
389                            com.liferay.portal.kernel.exception.SystemException {
390                    getService().deleteQuestion(questionId);
391            }
392    
393            public static void deleteQuestion(
394                    com.liferay.portlet.polls.model.PollsQuestion question)
395                    throws com.liferay.portal.kernel.exception.PortalException,
396                            com.liferay.portal.kernel.exception.SystemException {
397                    getService().deleteQuestion(question);
398            }
399    
400            public static void deleteQuestions(long groupId)
401                    throws com.liferay.portal.kernel.exception.PortalException,
402                            com.liferay.portal.kernel.exception.SystemException {
403                    getService().deleteQuestions(groupId);
404            }
405    
406            public static com.liferay.portlet.polls.model.PollsQuestion getQuestion(
407                    long questionId)
408                    throws com.liferay.portal.kernel.exception.PortalException,
409                            com.liferay.portal.kernel.exception.SystemException {
410                    return getService().getQuestion(questionId);
411            }
412    
413            public static java.util.List<com.liferay.portlet.polls.model.PollsQuestion> getQuestions(
414                    long groupId)
415                    throws com.liferay.portal.kernel.exception.SystemException {
416                    return getService().getQuestions(groupId);
417            }
418    
419            public static java.util.List<com.liferay.portlet.polls.model.PollsQuestion> getQuestions(
420                    long groupId, int start, int end)
421                    throws com.liferay.portal.kernel.exception.SystemException {
422                    return getService().getQuestions(groupId, start, end);
423            }
424    
425            public static int getQuestionsCount(long groupId)
426                    throws com.liferay.portal.kernel.exception.SystemException {
427                    return getService().getQuestionsCount(groupId);
428            }
429    
430            public static com.liferay.portlet.polls.model.PollsQuestion updateQuestion(
431                    long userId, long questionId,
432                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
433                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
434                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
435                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
436                    java.util.List<com.liferay.portlet.polls.model.PollsChoice> choices,
437                    com.liferay.portal.service.ServiceContext serviceContext)
438                    throws com.liferay.portal.kernel.exception.PortalException,
439                            com.liferay.portal.kernel.exception.SystemException {
440                    return getService()
441                                       .updateQuestion(userId, questionId, titleMap,
442                            descriptionMap, expirationDateMonth, expirationDateDay,
443                            expirationDateYear, expirationDateHour, expirationDateMinute,
444                            neverExpire, choices, serviceContext);
445            }
446    
447            public static PollsQuestionLocalService getService() {
448                    if (_service == null) {
449                            _service = (PollsQuestionLocalService)PortalBeanLocatorUtil.locate(PollsQuestionLocalService.class.getName());
450    
451                            ReferenceRegistry.registerReference(PollsQuestionLocalServiceUtil.class,
452                                    "_service");
453                    }
454    
455                    return _service;
456            }
457    
458            /**
459             * @deprecated As of 6.2.0
460             */
461            public void setService(PollsQuestionLocalService service) {
462            }
463    
464            private static PollsQuestionLocalService _service;
465    }