001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.polls.service;
016    
017    import com.liferay.portal.kernel.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    import com.liferay.portal.service.PersistedModelLocalService;
023    
024    /**
025     * The interface for the polls vote local service.
026     *
027     * <p>
028     * 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.
029     * </p>
030     *
031     * @author Brian Wing Shun Chan
032     * @see PollsVoteLocalServiceUtil
033     * @see com.liferay.portlet.polls.service.base.PollsVoteLocalServiceBaseImpl
034     * @see com.liferay.portlet.polls.service.impl.PollsVoteLocalServiceImpl
035     * @generated
036     */
037    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
038            PortalException.class, SystemException.class})
039    public interface PollsVoteLocalService extends PersistedModelLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify or reference this interface directly. Always use {@link PollsVoteLocalServiceUtil} to access the polls vote local service. Add custom service methods to {@link com.liferay.portlet.polls.service.impl.PollsVoteLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
044             */
045    
046            /**
047            * Adds the polls vote to the database. Also notifies the appropriate model listeners.
048            *
049            * @param pollsVote the polls vote
050            * @return the polls vote that was added
051            * @throws SystemException if a system exception occurred
052            */
053            public com.liferay.portlet.polls.model.PollsVote addPollsVote(
054                    com.liferay.portlet.polls.model.PollsVote pollsVote)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            /**
058            * Creates a new polls vote with the primary key. Does not add the polls vote to the database.
059            *
060            * @param voteId the primary key for the new polls vote
061            * @return the new polls vote
062            */
063            public com.liferay.portlet.polls.model.PollsVote createPollsVote(
064                    long voteId);
065    
066            /**
067            * Deletes the polls vote with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param voteId the primary key of the polls vote
070            * @throws PortalException if a polls vote with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public void deletePollsVote(long voteId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            /**
078            * Deletes the polls vote from the database. Also notifies the appropriate model listeners.
079            *
080            * @param pollsVote the polls vote
081            * @throws SystemException if a system exception occurred
082            */
083            public void deletePollsVote(
084                    com.liferay.portlet.polls.model.PollsVote pollsVote)
085                    throws com.liferay.portal.kernel.exception.SystemException;
086    
087            /**
088            * Performs a dynamic query on the database and returns the matching rows.
089            *
090            * @param dynamicQuery the dynamic query
091            * @return the matching rows
092            * @throws SystemException if a system exception occurred
093            */
094            @SuppressWarnings("rawtypes")
095            public java.util.List dynamicQuery(
096                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
097                    throws com.liferay.portal.kernel.exception.SystemException;
098    
099            /**
100            * Performs a dynamic query on the database and returns a range of the matching rows.
101            *
102            * <p>
103            * 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.
104            * </p>
105            *
106            * @param dynamicQuery the dynamic query
107            * @param start the lower bound of the range of model instances
108            * @param end the upper bound of the range of model instances (not inclusive)
109            * @return the range of matching rows
110            * @throws SystemException if a system exception occurred
111            */
112            @SuppressWarnings("rawtypes")
113            public java.util.List dynamicQuery(
114                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
115                    int end) throws com.liferay.portal.kernel.exception.SystemException;
116    
117            /**
118            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
119            *
120            * <p>
121            * 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.
122            * </p>
123            *
124            * @param dynamicQuery the dynamic query
125            * @param start the lower bound of the range of model instances
126            * @param end the upper bound of the range of model instances (not inclusive)
127            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
128            * @return the ordered range of matching rows
129            * @throws SystemException if a system exception occurred
130            */
131            @SuppressWarnings("rawtypes")
132            public java.util.List dynamicQuery(
133                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
134                    int end,
135                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
136                    throws com.liferay.portal.kernel.exception.SystemException;
137    
138            /**
139            * Returns the number of rows that match the dynamic query.
140            *
141            * @param dynamicQuery the dynamic query
142            * @return the number of rows that match the dynamic query
143            * @throws SystemException if a system exception occurred
144            */
145            public long dynamicQueryCount(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
147                    throws com.liferay.portal.kernel.exception.SystemException;
148    
149            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
150            public com.liferay.portlet.polls.model.PollsVote fetchPollsVote(long voteId)
151                    throws com.liferay.portal.kernel.exception.SystemException;
152    
153            /**
154            * Returns the polls vote with the primary key.
155            *
156            * @param voteId the primary key of the polls vote
157            * @return the polls vote
158            * @throws PortalException if a polls vote with the primary key could not be found
159            * @throws SystemException if a system exception occurred
160            */
161            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
162            public com.liferay.portlet.polls.model.PollsVote getPollsVote(long voteId)
163                    throws com.liferay.portal.kernel.exception.PortalException,
164                            com.liferay.portal.kernel.exception.SystemException;
165    
166            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
167            public com.liferay.portal.model.PersistedModel getPersistedModel(
168                    java.io.Serializable primaryKeyObj)
169                    throws com.liferay.portal.kernel.exception.PortalException,
170                            com.liferay.portal.kernel.exception.SystemException;
171    
172            /**
173            * Returns a range of all the polls votes.
174            *
175            * <p>
176            * 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.
177            * </p>
178            *
179            * @param start the lower bound of the range of polls votes
180            * @param end the upper bound of the range of polls votes (not inclusive)
181            * @return the range of polls votes
182            * @throws SystemException if a system exception occurred
183            */
184            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185            public java.util.List<com.liferay.portlet.polls.model.PollsVote> getPollsVotes(
186                    int start, int end)
187                    throws com.liferay.portal.kernel.exception.SystemException;
188    
189            /**
190            * Returns the number of polls votes.
191            *
192            * @return the number of polls votes
193            * @throws SystemException if a system exception occurred
194            */
195            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
196            public int getPollsVotesCount()
197                    throws com.liferay.portal.kernel.exception.SystemException;
198    
199            /**
200            * Updates the polls vote in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
201            *
202            * @param pollsVote the polls vote
203            * @return the polls vote that was updated
204            * @throws SystemException if a system exception occurred
205            */
206            public com.liferay.portlet.polls.model.PollsVote updatePollsVote(
207                    com.liferay.portlet.polls.model.PollsVote pollsVote)
208                    throws com.liferay.portal.kernel.exception.SystemException;
209    
210            /**
211            * Updates the polls vote in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
212            *
213            * @param pollsVote the polls vote
214            * @param merge whether to merge the polls vote 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.
215            * @return the polls vote that was updated
216            * @throws SystemException if a system exception occurred
217            */
218            public com.liferay.portlet.polls.model.PollsVote updatePollsVote(
219                    com.liferay.portlet.polls.model.PollsVote pollsVote, boolean merge)
220                    throws com.liferay.portal.kernel.exception.SystemException;
221    
222            /**
223            * Returns the Spring bean ID for this bean.
224            *
225            * @return the Spring bean ID for this bean
226            */
227            public java.lang.String getBeanIdentifier();
228    
229            /**
230            * Sets the Spring bean ID for this bean.
231            *
232            * @param beanIdentifier the Spring bean ID for this bean
233            */
234            public void setBeanIdentifier(java.lang.String beanIdentifier);
235    
236            public com.liferay.portlet.polls.model.PollsVote addVote(long userId,
237                    long questionId, long choiceId,
238                    com.liferay.portal.service.ServiceContext serviceContext)
239                    throws com.liferay.portal.kernel.exception.PortalException,
240                            com.liferay.portal.kernel.exception.SystemException;
241    
242            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
243            public java.util.List<com.liferay.portlet.polls.model.PollsVote> getChoiceVotes(
244                    long choiceId, int start, int end)
245                    throws com.liferay.portal.kernel.exception.SystemException;
246    
247            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
248            public int getChoiceVotesCount(long choiceId)
249                    throws com.liferay.portal.kernel.exception.SystemException;
250    
251            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
252            public java.util.List<com.liferay.portlet.polls.model.PollsVote> getQuestionVotes(
253                    long questionId, int start, int end)
254                    throws com.liferay.portal.kernel.exception.SystemException;
255    
256            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
257            public int getQuestionVotesCount(long questionId)
258                    throws com.liferay.portal.kernel.exception.SystemException;
259    
260            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
261            public com.liferay.portlet.polls.model.PollsVote getVote(long questionId,
262                    long userId)
263                    throws com.liferay.portal.kernel.exception.PortalException,
264                            com.liferay.portal.kernel.exception.SystemException;
265    }