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.exception.PortalException; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.kernel.transaction.Isolation; 022 import com.liferay.portal.kernel.transaction.Propagation; 023 import com.liferay.portal.kernel.transaction.Transactional; 024 import com.liferay.portal.service.BaseLocalService; 025 import com.liferay.portal.service.PersistedModelLocalService; 026 027 /** 028 * Provides the local service interface for PollsVote. Methods of this 029 * service will not have security checks based on the propagated JAAS 030 * credentials because this service can only be accessed from within the same 031 * VM. 032 * 033 * @author Brian Wing Shun Chan 034 * @see PollsVoteLocalServiceUtil 035 * @see com.liferay.portlet.polls.service.base.PollsVoteLocalServiceBaseImpl 036 * @see com.liferay.portlet.polls.service.impl.PollsVoteLocalServiceImpl 037 * @generated 038 */ 039 @ProviderType 040 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 041 PortalException.class, SystemException.class}) 042 public interface PollsVoteLocalService extends BaseLocalService, 043 PersistedModelLocalService { 044 /* 045 * NOTE FOR DEVELOPERS: 046 * 047 * 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. 048 */ 049 050 /** 051 * Adds the polls vote to the database. Also notifies the appropriate model listeners. 052 * 053 * @param pollsVote the polls vote 054 * @return the polls vote that was added 055 * @throws SystemException if a system exception occurred 056 */ 057 public com.liferay.portlet.polls.model.PollsVote addPollsVote( 058 com.liferay.portlet.polls.model.PollsVote pollsVote) 059 throws com.liferay.portal.kernel.exception.SystemException; 060 061 /** 062 * Creates a new polls vote with the primary key. Does not add the polls vote to the database. 063 * 064 * @param voteId the primary key for the new polls vote 065 * @return the new polls vote 066 */ 067 public com.liferay.portlet.polls.model.PollsVote createPollsVote( 068 long voteId); 069 070 /** 071 * Deletes the polls vote with the primary key from the database. Also notifies the appropriate model listeners. 072 * 073 * @param voteId the primary key of the polls vote 074 * @return the polls vote that was removed 075 * @throws PortalException if a polls vote with the primary key could not be found 076 * @throws SystemException if a system exception occurred 077 */ 078 public com.liferay.portlet.polls.model.PollsVote deletePollsVote( 079 long voteId) 080 throws com.liferay.portal.kernel.exception.PortalException, 081 com.liferay.portal.kernel.exception.SystemException; 082 083 /** 084 * Deletes the polls vote from the database. Also notifies the appropriate model listeners. 085 * 086 * @param pollsVote the polls vote 087 * @return the polls vote that was removed 088 * @throws SystemException if a system exception occurred 089 */ 090 public com.liferay.portlet.polls.model.PollsVote deletePollsVote( 091 com.liferay.portlet.polls.model.PollsVote pollsVote) 092 throws com.liferay.portal.kernel.exception.SystemException; 093 094 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 095 096 /** 097 * Performs a dynamic query on the database and returns the matching rows. 098 * 099 * @param dynamicQuery the dynamic query 100 * @return the matching rows 101 * @throws SystemException if a system exception occurred 102 */ 103 @SuppressWarnings("rawtypes") 104 public java.util.List dynamicQuery( 105 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 106 throws com.liferay.portal.kernel.exception.SystemException; 107 108 /** 109 * Performs a dynamic query on the database and returns a range of the matching rows. 110 * 111 * <p> 112 * 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.PollsVoteModelImpl}. 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. 113 * </p> 114 * 115 * @param dynamicQuery the dynamic query 116 * @param start the lower bound of the range of model instances 117 * @param end the upper bound of the range of model instances (not inclusive) 118 * @return the range of matching rows 119 * @throws SystemException if a system exception occurred 120 */ 121 @SuppressWarnings("rawtypes") 122 public java.util.List dynamicQuery( 123 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 124 int end) throws com.liferay.portal.kernel.exception.SystemException; 125 126 /** 127 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 128 * 129 * <p> 130 * 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.PollsVoteModelImpl}. 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. 131 * </p> 132 * 133 * @param dynamicQuery the dynamic query 134 * @param start the lower bound of the range of model instances 135 * @param end the upper bound of the range of model instances (not inclusive) 136 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 137 * @return the ordered range of matching rows 138 * @throws SystemException if a system exception occurred 139 */ 140 @SuppressWarnings("rawtypes") 141 public java.util.List dynamicQuery( 142 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 143 int end, 144 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 145 throws com.liferay.portal.kernel.exception.SystemException; 146 147 /** 148 * Returns the number of rows that match the dynamic query. 149 * 150 * @param dynamicQuery the dynamic query 151 * @return the number of rows that match the dynamic query 152 * @throws SystemException if a system exception occurred 153 */ 154 public long dynamicQueryCount( 155 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 156 throws com.liferay.portal.kernel.exception.SystemException; 157 158 /** 159 * Returns the number of rows that match the dynamic query. 160 * 161 * @param dynamicQuery the dynamic query 162 * @param projection the projection to apply to the query 163 * @return the number of rows that match the dynamic query 164 * @throws SystemException if a system exception occurred 165 */ 166 public long dynamicQueryCount( 167 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 168 com.liferay.portal.kernel.dao.orm.Projection projection) 169 throws com.liferay.portal.kernel.exception.SystemException; 170 171 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 172 public com.liferay.portlet.polls.model.PollsVote fetchPollsVote(long voteId) 173 throws com.liferay.portal.kernel.exception.SystemException; 174 175 /** 176 * Returns the polls vote with the matching UUID and company. 177 * 178 * @param uuid the polls vote's UUID 179 * @param companyId the primary key of the company 180 * @return the matching polls vote, or <code>null</code> if a matching polls vote could not be found 181 * @throws SystemException if a system exception occurred 182 */ 183 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 184 public com.liferay.portlet.polls.model.PollsVote fetchPollsVoteByUuidAndCompanyId( 185 java.lang.String uuid, long companyId) 186 throws com.liferay.portal.kernel.exception.SystemException; 187 188 /** 189 * Returns the polls vote matching the UUID and group. 190 * 191 * @param uuid the polls vote's UUID 192 * @param groupId the primary key of the group 193 * @return the matching polls vote, or <code>null</code> if a matching polls vote could not be found 194 * @throws SystemException if a system exception occurred 195 */ 196 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 197 public com.liferay.portlet.polls.model.PollsVote fetchPollsVoteByUuidAndGroupId( 198 java.lang.String uuid, long groupId) 199 throws com.liferay.portal.kernel.exception.SystemException; 200 201 /** 202 * Returns the polls vote with the primary key. 203 * 204 * @param voteId the primary key of the polls vote 205 * @return the polls vote 206 * @throws PortalException if a polls vote with the primary key could not be found 207 * @throws SystemException if a system exception occurred 208 */ 209 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 210 public com.liferay.portlet.polls.model.PollsVote getPollsVote(long voteId) 211 throws com.liferay.portal.kernel.exception.PortalException, 212 com.liferay.portal.kernel.exception.SystemException; 213 214 @Override 215 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 216 public com.liferay.portal.model.PersistedModel getPersistedModel( 217 java.io.Serializable primaryKeyObj) 218 throws com.liferay.portal.kernel.exception.PortalException, 219 com.liferay.portal.kernel.exception.SystemException; 220 221 /** 222 * Returns the polls vote with the matching UUID and company. 223 * 224 * @param uuid the polls vote's UUID 225 * @param companyId the primary key of the company 226 * @return the matching polls vote 227 * @throws PortalException if a matching polls vote could not be found 228 * @throws SystemException if a system exception occurred 229 */ 230 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 231 public com.liferay.portlet.polls.model.PollsVote getPollsVoteByUuidAndCompanyId( 232 java.lang.String uuid, long companyId) 233 throws com.liferay.portal.kernel.exception.PortalException, 234 com.liferay.portal.kernel.exception.SystemException; 235 236 /** 237 * Returns the polls vote matching the UUID and group. 238 * 239 * @param uuid the polls vote's UUID 240 * @param groupId the primary key of the group 241 * @return the matching polls vote 242 * @throws PortalException if a matching polls vote could not be found 243 * @throws SystemException if a system exception occurred 244 */ 245 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 246 public com.liferay.portlet.polls.model.PollsVote getPollsVoteByUuidAndGroupId( 247 java.lang.String uuid, long groupId) 248 throws com.liferay.portal.kernel.exception.PortalException, 249 com.liferay.portal.kernel.exception.SystemException; 250 251 /** 252 * Returns a range of all the polls votes. 253 * 254 * <p> 255 * 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.PollsVoteModelImpl}. 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. 256 * </p> 257 * 258 * @param start the lower bound of the range of polls votes 259 * @param end the upper bound of the range of polls votes (not inclusive) 260 * @return the range of polls votes 261 * @throws SystemException if a system exception occurred 262 */ 263 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 264 public java.util.List<com.liferay.portlet.polls.model.PollsVote> getPollsVotes( 265 int start, int end) 266 throws com.liferay.portal.kernel.exception.SystemException; 267 268 /** 269 * Returns the number of polls votes. 270 * 271 * @return the number of polls votes 272 * @throws SystemException if a system exception occurred 273 */ 274 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 275 public int getPollsVotesCount() 276 throws com.liferay.portal.kernel.exception.SystemException; 277 278 /** 279 * Updates the polls vote in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 280 * 281 * @param pollsVote the polls vote 282 * @return the polls vote that was updated 283 * @throws SystemException if a system exception occurred 284 */ 285 public com.liferay.portlet.polls.model.PollsVote updatePollsVote( 286 com.liferay.portlet.polls.model.PollsVote pollsVote) 287 throws com.liferay.portal.kernel.exception.SystemException; 288 289 /** 290 * Returns the Spring bean ID for this bean. 291 * 292 * @return the Spring bean ID for this bean 293 */ 294 public java.lang.String getBeanIdentifier(); 295 296 /** 297 * Sets the Spring bean ID for this bean. 298 * 299 * @param beanIdentifier the Spring bean ID for this bean 300 */ 301 public void setBeanIdentifier(java.lang.String beanIdentifier); 302 303 public com.liferay.portlet.polls.model.PollsVote addVote(long userId, 304 long questionId, long choiceId, 305 com.liferay.portal.service.ServiceContext serviceContext) 306 throws com.liferay.portal.kernel.exception.PortalException, 307 com.liferay.portal.kernel.exception.SystemException; 308 309 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 310 public java.util.List<com.liferay.portlet.polls.model.PollsVote> getChoiceVotes( 311 long choiceId, int start, int end) 312 throws com.liferay.portal.kernel.exception.SystemException; 313 314 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 315 public int getChoiceVotesCount(long choiceId) 316 throws com.liferay.portal.kernel.exception.SystemException; 317 318 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 319 public java.util.List<com.liferay.portlet.polls.model.PollsVote> getQuestionVotes( 320 long questionId, int start, int end) 321 throws com.liferay.portal.kernel.exception.SystemException; 322 323 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 324 public int getQuestionVotesCount(long questionId) 325 throws com.liferay.portal.kernel.exception.SystemException; 326 327 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 328 public com.liferay.portlet.polls.model.PollsVote getVote(long questionId, 329 long userId) 330 throws com.liferay.portal.kernel.exception.PortalException, 331 com.liferay.portal.kernel.exception.SystemException; 332 }