001 /** 002 * Copyright (c) 2000-2010 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.model; 016 017 import com.liferay.portal.kernel.annotation.AutoEscape; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.model.BaseModel; 020 import com.liferay.portal.service.ServiceContext; 021 022 import com.liferay.portlet.expando.model.ExpandoBridge; 023 024 import java.io.Serializable; 025 026 import java.util.Date; 027 import java.util.Locale; 028 import java.util.Map; 029 030 /** 031 * The base model interface for the PollsQuestion service. Represents a row in the "PollsQuestion" database table, with each column mapped to a property of this class. 032 * 033 * <p> 034 * This interface and its corresponding implementation {@link com.liferay.portlet.polls.model.impl.PollsQuestionModelImpl} exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in {@link com.liferay.portlet.polls.model.impl.PollsQuestionImpl}. 035 * </p> 036 * 037 * <p> 038 * Never modify or reference this interface directly. All methods that expect a polls question model instance should use the {@link PollsQuestion} interface instead. 039 * </p> 040 * 041 * @author Brian Wing Shun Chan 042 * @see PollsQuestion 043 * @see com.liferay.portlet.polls.model.impl.PollsQuestionImpl 044 * @see com.liferay.portlet.polls.model.impl.PollsQuestionModelImpl 045 * @generated 046 */ 047 public interface PollsQuestionModel extends BaseModel<PollsQuestion> { 048 /** 049 * Gets the primary key of this polls question. 050 * 051 * @return the primary key of this polls question 052 */ 053 public long getPrimaryKey(); 054 055 /** 056 * Sets the primary key of this polls question 057 * 058 * @param pk the primary key of this polls question 059 */ 060 public void setPrimaryKey(long pk); 061 062 /** 063 * Gets the uuid of this polls question. 064 * 065 * @return the uuid of this polls question 066 */ 067 @AutoEscape 068 public String getUuid(); 069 070 /** 071 * Sets the uuid of this polls question. 072 * 073 * @param uuid the uuid of this polls question 074 */ 075 public void setUuid(String uuid); 076 077 /** 078 * Gets the question id of this polls question. 079 * 080 * @return the question id of this polls question 081 */ 082 public long getQuestionId(); 083 084 /** 085 * Sets the question id of this polls question. 086 * 087 * @param questionId the question id of this polls question 088 */ 089 public void setQuestionId(long questionId); 090 091 /** 092 * Gets the group id of this polls question. 093 * 094 * @return the group id of this polls question 095 */ 096 public long getGroupId(); 097 098 /** 099 * Sets the group id of this polls question. 100 * 101 * @param groupId the group id of this polls question 102 */ 103 public void setGroupId(long groupId); 104 105 /** 106 * Gets the company id of this polls question. 107 * 108 * @return the company id of this polls question 109 */ 110 public long getCompanyId(); 111 112 /** 113 * Sets the company id of this polls question. 114 * 115 * @param companyId the company id of this polls question 116 */ 117 public void setCompanyId(long companyId); 118 119 /** 120 * Gets the user id of this polls question. 121 * 122 * @return the user id of this polls question 123 */ 124 public long getUserId(); 125 126 /** 127 * Sets the user id of this polls question. 128 * 129 * @param userId the user id of this polls question 130 */ 131 public void setUserId(long userId); 132 133 /** 134 * Gets the user uuid of this polls question. 135 * 136 * @return the user uuid of this polls question 137 * @throws SystemException if a system exception occurred 138 */ 139 public String getUserUuid() throws SystemException; 140 141 /** 142 * Sets the user uuid of this polls question. 143 * 144 * @param userUuid the user uuid of this polls question 145 */ 146 public void setUserUuid(String userUuid); 147 148 /** 149 * Gets the user name of this polls question. 150 * 151 * @return the user name of this polls question 152 */ 153 @AutoEscape 154 public String getUserName(); 155 156 /** 157 * Sets the user name of this polls question. 158 * 159 * @param userName the user name of this polls question 160 */ 161 public void setUserName(String userName); 162 163 /** 164 * Gets the create date of this polls question. 165 * 166 * @return the create date of this polls question 167 */ 168 public Date getCreateDate(); 169 170 /** 171 * Sets the create date of this polls question. 172 * 173 * @param createDate the create date of this polls question 174 */ 175 public void setCreateDate(Date createDate); 176 177 /** 178 * Gets the modified date of this polls question. 179 * 180 * @return the modified date of this polls question 181 */ 182 public Date getModifiedDate(); 183 184 /** 185 * Sets the modified date of this polls question. 186 * 187 * @param modifiedDate the modified date of this polls question 188 */ 189 public void setModifiedDate(Date modifiedDate); 190 191 /** 192 * Gets the title of this polls question. 193 * 194 * @return the title of this polls question 195 */ 196 public String getTitle(); 197 198 /** 199 * Gets the localized title of this polls question. Uses the default language if no localization exists for the requested language. 200 * 201 * @param locale the locale to get the localized title for 202 * @return the localized title of this polls question 203 */ 204 public String getTitle(Locale locale); 205 206 /** 207 * Gets the localized title of this polls question, optionally using the default language if no localization exists for the requested language. 208 * 209 * @param locale the local to get the localized title for 210 * @param useDefault whether to use the default language if no localization exists for the requested language 211 * @return the localized title of this polls question. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 212 */ 213 public String getTitle(Locale locale, boolean useDefault); 214 215 /** 216 * Gets the localized title of this polls question. Uses the default language if no localization exists for the requested language. 217 * 218 * @param languageId the id of the language to get the localized title for 219 * @return the localized title of this polls question 220 */ 221 public String getTitle(String languageId); 222 223 /** 224 * Gets the localized title of this polls question, optionally using the default language if no localization exists for the requested language. 225 * 226 * @param languageId the id of the language to get the localized title for 227 * @param useDefault whether to use the default language if no localization exists for the requested language 228 * @return the localized title of this polls question 229 */ 230 public String getTitle(String languageId, boolean useDefault); 231 232 /** 233 * Gets a map of the locales and localized title of this polls question. 234 * 235 * @return the locales and localized title 236 */ 237 public Map<Locale, String> getTitleMap(); 238 239 /** 240 * Sets the title of this polls question. 241 * 242 * @param title the title of this polls question 243 */ 244 public void setTitle(String title); 245 246 /** 247 * Sets the localized title of this polls question. 248 * 249 * @param locale the locale to set the localized title for 250 * @param title the localized title of this polls question 251 */ 252 public void setTitle(Locale locale, String title); 253 254 /** 255 * Sets the localized titles of this polls question from the map of locales and localized titles. 256 * 257 * @param titleMap the locales and localized titles of this polls question 258 */ 259 public void setTitleMap(Map<Locale, String> titleMap); 260 261 /** 262 * Gets the description of this polls question. 263 * 264 * @return the description of this polls question 265 */ 266 public String getDescription(); 267 268 /** 269 * Gets the localized description of this polls question. Uses the default language if no localization exists for the requested language. 270 * 271 * @param locale the locale to get the localized description for 272 * @return the localized description of this polls question 273 */ 274 public String getDescription(Locale locale); 275 276 /** 277 * Gets the localized description of this polls question, optionally using the default language if no localization exists for the requested language. 278 * 279 * @param locale the local to get the localized description for 280 * @param useDefault whether to use the default language if no localization exists for the requested language 281 * @return the localized description of this polls question. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 282 */ 283 public String getDescription(Locale locale, boolean useDefault); 284 285 /** 286 * Gets the localized description of this polls question. Uses the default language if no localization exists for the requested language. 287 * 288 * @param languageId the id of the language to get the localized description for 289 * @return the localized description of this polls question 290 */ 291 public String getDescription(String languageId); 292 293 /** 294 * Gets the localized description of this polls question, optionally using the default language if no localization exists for the requested language. 295 * 296 * @param languageId the id of the language to get the localized description for 297 * @param useDefault whether to use the default language if no localization exists for the requested language 298 * @return the localized description of this polls question 299 */ 300 public String getDescription(String languageId, boolean useDefault); 301 302 /** 303 * Gets a map of the locales and localized description of this polls question. 304 * 305 * @return the locales and localized description 306 */ 307 public Map<Locale, String> getDescriptionMap(); 308 309 /** 310 * Sets the description of this polls question. 311 * 312 * @param description the description of this polls question 313 */ 314 public void setDescription(String description); 315 316 /** 317 * Sets the localized description of this polls question. 318 * 319 * @param locale the locale to set the localized description for 320 * @param description the localized description of this polls question 321 */ 322 public void setDescription(Locale locale, String description); 323 324 /** 325 * Sets the localized descriptions of this polls question from the map of locales and localized descriptions. 326 * 327 * @param descriptionMap the locales and localized descriptions of this polls question 328 */ 329 public void setDescriptionMap(Map<Locale, String> descriptionMap); 330 331 /** 332 * Gets the expiration date of this polls question. 333 * 334 * @return the expiration date of this polls question 335 */ 336 public Date getExpirationDate(); 337 338 /** 339 * Sets the expiration date of this polls question. 340 * 341 * @param expirationDate the expiration date of this polls question 342 */ 343 public void setExpirationDate(Date expirationDate); 344 345 /** 346 * Gets the last vote date of this polls question. 347 * 348 * @return the last vote date of this polls question 349 */ 350 public Date getLastVoteDate(); 351 352 /** 353 * Sets the last vote date of this polls question. 354 * 355 * @param lastVoteDate the last vote date of this polls question 356 */ 357 public void setLastVoteDate(Date lastVoteDate); 358 359 /** 360 * Gets a copy of this polls question as an escaped model instance by wrapping it with an {@link com.liferay.portal.kernel.bean.AutoEscapeBeanHandler}. 361 * 362 * @return the escaped model instance 363 * @see com.liferay.portal.kernel.bean.AutoEscapeBeanHandler 364 */ 365 public PollsQuestion toEscapedModel(); 366 367 public boolean isNew(); 368 369 public void setNew(boolean n); 370 371 public boolean isCachedModel(); 372 373 public void setCachedModel(boolean cachedModel); 374 375 public boolean isEscapedModel(); 376 377 public void setEscapedModel(boolean escapedModel); 378 379 public Serializable getPrimaryKeyObj(); 380 381 public ExpandoBridge getExpandoBridge(); 382 383 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 384 385 public Object clone(); 386 387 public int compareTo(PollsQuestion pollsQuestion); 388 389 public int hashCode(); 390 391 public String toString(); 392 393 public String toXmlString(); 394 }