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