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 * The utility for the polls choice local service. This utility wraps {@link com.liferay.portlet.polls.service.impl.PollsChoiceLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server. 022 * 023 * <p> 024 * 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. 025 * </p> 026 * 027 * @author Brian Wing Shun Chan 028 * @see PollsChoiceLocalService 029 * @see com.liferay.portlet.polls.service.base.PollsChoiceLocalServiceBaseImpl 030 * @see com.liferay.portlet.polls.service.impl.PollsChoiceLocalServiceImpl 031 * @generated 032 */ 033 public class PollsChoiceLocalServiceUtil { 034 /* 035 * NOTE FOR DEVELOPERS: 036 * 037 * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.polls.service.impl.PollsChoiceLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 038 */ 039 040 /** 041 * Adds the polls choice to the database. Also notifies the appropriate model listeners. 042 * 043 * @param pollsChoice the polls choice 044 * @return the polls choice that was added 045 * @throws SystemException if a system exception occurred 046 */ 047 public static com.liferay.portlet.polls.model.PollsChoice addPollsChoice( 048 com.liferay.portlet.polls.model.PollsChoice pollsChoice) 049 throws com.liferay.portal.kernel.exception.SystemException { 050 return getService().addPollsChoice(pollsChoice); 051 } 052 053 /** 054 * Creates a new polls choice with the primary key. Does not add the polls choice to the database. 055 * 056 * @param choiceId the primary key for the new polls choice 057 * @return the new polls choice 058 */ 059 public static com.liferay.portlet.polls.model.PollsChoice createPollsChoice( 060 long choiceId) { 061 return getService().createPollsChoice(choiceId); 062 } 063 064 /** 065 * Deletes the polls choice with the primary key from the database. Also notifies the appropriate model listeners. 066 * 067 * @param choiceId the primary key of the polls choice 068 * @return the polls choice that was removed 069 * @throws PortalException if a polls choice with the primary key could not be found 070 * @throws SystemException if a system exception occurred 071 */ 072 public static com.liferay.portlet.polls.model.PollsChoice deletePollsChoice( 073 long choiceId) 074 throws com.liferay.portal.kernel.exception.PortalException, 075 com.liferay.portal.kernel.exception.SystemException { 076 return getService().deletePollsChoice(choiceId); 077 } 078 079 /** 080 * Deletes the polls choice from the database. Also notifies the appropriate model listeners. 081 * 082 * @param pollsChoice the polls choice 083 * @return the polls choice that was removed 084 * @throws SystemException if a system exception occurred 085 */ 086 public static com.liferay.portlet.polls.model.PollsChoice deletePollsChoice( 087 com.liferay.portlet.polls.model.PollsChoice pollsChoice) 088 throws com.liferay.portal.kernel.exception.SystemException { 089 return getService().deletePollsChoice(pollsChoice); 090 } 091 092 public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 093 return getService().dynamicQuery(); 094 } 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 static java.util.List dynamicQuery( 105 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 106 throws com.liferay.portal.kernel.exception.SystemException { 107 return getService().dynamicQuery(dynamicQuery); 108 } 109 110 /** 111 * Performs a dynamic query on the database and returns a range of the matching rows. 112 * 113 * <p> 114 * 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.PollsChoiceModelImpl}. 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. 115 * </p> 116 * 117 * @param dynamicQuery the dynamic query 118 * @param start the lower bound of the range of model instances 119 * @param end the upper bound of the range of model instances (not inclusive) 120 * @return the range of matching rows 121 * @throws SystemException if a system exception occurred 122 */ 123 @SuppressWarnings("rawtypes") 124 public static java.util.List dynamicQuery( 125 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 126 int end) throws com.liferay.portal.kernel.exception.SystemException { 127 return getService().dynamicQuery(dynamicQuery, start, end); 128 } 129 130 /** 131 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 132 * 133 * <p> 134 * 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.PollsChoiceModelImpl}. 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. 135 * </p> 136 * 137 * @param dynamicQuery the dynamic query 138 * @param start the lower bound of the range of model instances 139 * @param end the upper bound of the range of model instances (not inclusive) 140 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 141 * @return the ordered range of matching rows 142 * @throws SystemException if a system exception occurred 143 */ 144 @SuppressWarnings("rawtypes") 145 public static java.util.List dynamicQuery( 146 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 147 int end, 148 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 149 throws com.liferay.portal.kernel.exception.SystemException { 150 return getService() 151 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 152 } 153 154 /** 155 * Returns the number of rows that match the dynamic query. 156 * 157 * @param dynamicQuery the dynamic query 158 * @return the number of rows that match the dynamic query 159 * @throws SystemException if a system exception occurred 160 */ 161 public static long dynamicQueryCount( 162 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 163 throws com.liferay.portal.kernel.exception.SystemException { 164 return getService().dynamicQueryCount(dynamicQuery); 165 } 166 167 public static com.liferay.portlet.polls.model.PollsChoice fetchPollsChoice( 168 long choiceId) 169 throws com.liferay.portal.kernel.exception.SystemException { 170 return getService().fetchPollsChoice(choiceId); 171 } 172 173 /** 174 * Returns the polls choice with the primary key. 175 * 176 * @param choiceId the primary key of the polls choice 177 * @return the polls choice 178 * @throws PortalException if a polls choice with the primary key could not be found 179 * @throws SystemException if a system exception occurred 180 */ 181 public static com.liferay.portlet.polls.model.PollsChoice getPollsChoice( 182 long choiceId) 183 throws com.liferay.portal.kernel.exception.PortalException, 184 com.liferay.portal.kernel.exception.SystemException { 185 return getService().getPollsChoice(choiceId); 186 } 187 188 public static com.liferay.portal.model.PersistedModel getPersistedModel( 189 java.io.Serializable primaryKeyObj) 190 throws com.liferay.portal.kernel.exception.PortalException, 191 com.liferay.portal.kernel.exception.SystemException { 192 return getService().getPersistedModel(primaryKeyObj); 193 } 194 195 /** 196 * Returns the polls choice matching the UUID and group. 197 * 198 * @param uuid the polls choice's UUID 199 * @param groupId the primary key of the group 200 * @return the matching polls choice 201 * @throws PortalException if a matching polls choice could not be found 202 * @throws SystemException if a system exception occurred 203 */ 204 public static com.liferay.portlet.polls.model.PollsChoice getPollsChoiceByUuidAndGroupId( 205 java.lang.String uuid, long groupId) 206 throws com.liferay.portal.kernel.exception.PortalException, 207 com.liferay.portal.kernel.exception.SystemException { 208 return getService().getPollsChoiceByUuidAndGroupId(uuid, groupId); 209 } 210 211 /** 212 * Returns a range of all the polls choices. 213 * 214 * <p> 215 * 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.PollsChoiceModelImpl}. 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. 216 * </p> 217 * 218 * @param start the lower bound of the range of polls choices 219 * @param end the upper bound of the range of polls choices (not inclusive) 220 * @return the range of polls choices 221 * @throws SystemException if a system exception occurred 222 */ 223 public static java.util.List<com.liferay.portlet.polls.model.PollsChoice> getPollsChoices( 224 int start, int end) 225 throws com.liferay.portal.kernel.exception.SystemException { 226 return getService().getPollsChoices(start, end); 227 } 228 229 /** 230 * Returns the number of polls choices. 231 * 232 * @return the number of polls choices 233 * @throws SystemException if a system exception occurred 234 */ 235 public static int getPollsChoicesCount() 236 throws com.liferay.portal.kernel.exception.SystemException { 237 return getService().getPollsChoicesCount(); 238 } 239 240 /** 241 * Updates the polls choice in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 242 * 243 * @param pollsChoice the polls choice 244 * @return the polls choice that was updated 245 * @throws SystemException if a system exception occurred 246 */ 247 public static com.liferay.portlet.polls.model.PollsChoice updatePollsChoice( 248 com.liferay.portlet.polls.model.PollsChoice pollsChoice) 249 throws com.liferay.portal.kernel.exception.SystemException { 250 return getService().updatePollsChoice(pollsChoice); 251 } 252 253 /** 254 * Returns the Spring bean ID for this bean. 255 * 256 * @return the Spring bean ID for this bean 257 */ 258 public static java.lang.String getBeanIdentifier() { 259 return getService().getBeanIdentifier(); 260 } 261 262 /** 263 * Sets the Spring bean ID for this bean. 264 * 265 * @param beanIdentifier the Spring bean ID for this bean 266 */ 267 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 268 getService().setBeanIdentifier(beanIdentifier); 269 } 270 271 public static com.liferay.portlet.polls.model.PollsChoice addChoice( 272 long userId, long questionId, java.lang.String name, 273 java.lang.String description, 274 com.liferay.portal.service.ServiceContext serviceContext) 275 throws com.liferay.portal.kernel.exception.PortalException, 276 com.liferay.portal.kernel.exception.SystemException { 277 return getService() 278 .addChoice(userId, questionId, name, description, 279 serviceContext); 280 } 281 282 public static com.liferay.portlet.polls.model.PollsChoice getChoice( 283 long choiceId) 284 throws com.liferay.portal.kernel.exception.PortalException, 285 com.liferay.portal.kernel.exception.SystemException { 286 return getService().getChoice(choiceId); 287 } 288 289 public static java.util.List<com.liferay.portlet.polls.model.PollsChoice> getChoices( 290 long questionId) 291 throws com.liferay.portal.kernel.exception.SystemException { 292 return getService().getChoices(questionId); 293 } 294 295 public static int getChoicesCount(long questionId) 296 throws com.liferay.portal.kernel.exception.SystemException { 297 return getService().getChoicesCount(questionId); 298 } 299 300 public static com.liferay.portlet.polls.model.PollsChoice updateChoice( 301 long choiceId, long questionId, java.lang.String name, 302 java.lang.String description, 303 com.liferay.portal.service.ServiceContext serviceContext) 304 throws com.liferay.portal.kernel.exception.PortalException, 305 com.liferay.portal.kernel.exception.SystemException { 306 return getService() 307 .updateChoice(choiceId, questionId, name, description, 308 serviceContext); 309 } 310 311 public static PollsChoiceLocalService getService() { 312 if (_service == null) { 313 _service = (PollsChoiceLocalService)PortalBeanLocatorUtil.locate(PollsChoiceLocalService.class.getName()); 314 315 ReferenceRegistry.registerReference(PollsChoiceLocalServiceUtil.class, 316 "_service"); 317 } 318 319 return _service; 320 } 321 322 /** 323 * @deprecated As of 6.2.0 324 */ 325 public void setService(PollsChoiceLocalService service) { 326 } 327 328 private static PollsChoiceLocalService _service; 329 }