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.model; 016 017 import com.liferay.portal.LocaleException; 018 import com.liferay.portal.kernel.bean.AutoEscape; 019 import com.liferay.portal.kernel.exception.SystemException; 020 import com.liferay.portal.model.BaseModel; 021 import com.liferay.portal.model.CacheModel; 022 import com.liferay.portal.model.GroupedModel; 023 import com.liferay.portal.service.ServiceContext; 024 025 import com.liferay.portlet.expando.model.ExpandoBridge; 026 027 import java.io.Serializable; 028 029 import java.util.Date; 030 import java.util.Locale; 031 import java.util.Map; 032 033 /** 034 * 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. 035 * 036 * <p> 037 * 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}. 038 * </p> 039 * 040 * @author Brian Wing Shun Chan 041 * @see PollsQuestion 042 * @see com.liferay.portlet.polls.model.impl.PollsQuestionImpl 043 * @see com.liferay.portlet.polls.model.impl.PollsQuestionModelImpl 044 * @generated 045 */ 046 public interface PollsQuestionModel extends BaseModel<PollsQuestion>, 047 GroupedModel { 048 /* 049 * NOTE FOR DEVELOPERS: 050 * 051 * Never modify or reference this interface directly. All methods that expect a polls question model instance should use the {@link PollsQuestion} interface instead. 052 */ 053 054 /** 055 * Returns the primary key of this polls question. 056 * 057 * @return the primary key of this polls question 058 */ 059 public long getPrimaryKey(); 060 061 /** 062 * Sets the primary key of this polls question. 063 * 064 * @param primaryKey the primary key of this polls question 065 */ 066 public void setPrimaryKey(long primaryKey); 067 068 /** 069 * Returns the uuid of this polls question. 070 * 071 * @return the uuid of this polls question 072 */ 073 @AutoEscape 074 public String getUuid(); 075 076 /** 077 * Sets the uuid of this polls question. 078 * 079 * @param uuid the uuid of this polls question 080 */ 081 public void setUuid(String uuid); 082 083 /** 084 * Returns the question ID of this polls question. 085 * 086 * @return the question ID of this polls question 087 */ 088 public long getQuestionId(); 089 090 /** 091 * Sets the question ID of this polls question. 092 * 093 * @param questionId the question ID of this polls question 094 */ 095 public void setQuestionId(long questionId); 096 097 /** 098 * Returns the group ID of this polls question. 099 * 100 * @return the group ID of this polls question 101 */ 102 public long getGroupId(); 103 104 /** 105 * Sets the group ID of this polls question. 106 * 107 * @param groupId the group ID of this polls question 108 */ 109 public void setGroupId(long groupId); 110 111 /** 112 * Returns the company ID of this polls question. 113 * 114 * @return the company ID of this polls question 115 */ 116 public long getCompanyId(); 117 118 /** 119 * Sets the company ID of this polls question. 120 * 121 * @param companyId the company ID of this polls question 122 */ 123 public void setCompanyId(long companyId); 124 125 /** 126 * Returns the user ID of this polls question. 127 * 128 * @return the user ID of this polls question 129 */ 130 public long getUserId(); 131 132 /** 133 * Sets the user ID of this polls question. 134 * 135 * @param userId the user ID of this polls question 136 */ 137 public void setUserId(long userId); 138 139 /** 140 * Returns the user uuid of this polls question. 141 * 142 * @return the user uuid of this polls question 143 * @throws SystemException if a system exception occurred 144 */ 145 public String getUserUuid() throws SystemException; 146 147 /** 148 * Sets the user uuid of this polls question. 149 * 150 * @param userUuid the user uuid of this polls question 151 */ 152 public void setUserUuid(String userUuid); 153 154 /** 155 * Returns the user name of this polls question. 156 * 157 * @return the user name of this polls question 158 */ 159 @AutoEscape 160 public String getUserName(); 161 162 /** 163 * Sets the user name of this polls question. 164 * 165 * @param userName the user name of this polls question 166 */ 167 public void setUserName(String userName); 168 169 /** 170 * Returns the create date of this polls question. 171 * 172 * @return the create date of this polls question 173 */ 174 public Date getCreateDate(); 175 176 /** 177 * Sets the create date of this polls question. 178 * 179 * @param createDate the create date of this polls question 180 */ 181 public void setCreateDate(Date createDate); 182 183 /** 184 * Returns the modified date of this polls question. 185 * 186 * @return the modified date of this polls question 187 */ 188 public Date getModifiedDate(); 189 190 /** 191 * Sets the modified date of this polls question. 192 * 193 * @param modifiedDate the modified date of this polls question 194 */ 195 public void setModifiedDate(Date modifiedDate); 196 197 /** 198 * Returns the title of this polls question. 199 * 200 * @return the title of this polls question 201 */ 202 public String getTitle(); 203 204 /** 205 * Returns the localized title of this polls question in the language. Uses the default language if no localization exists for the requested language. 206 * 207 * @param locale the locale of the language 208 * @return the localized title of this polls question 209 */ 210 @AutoEscape 211 public String getTitle(Locale locale); 212 213 /** 214 * Returns the localized title of this polls question in the language, optionally using the default language if no localization exists for the requested language. 215 * 216 * @param locale the local of the language 217 * @param useDefault whether to use the default language if no localization exists for the requested language 218 * @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. 219 */ 220 @AutoEscape 221 public String getTitle(Locale locale, boolean useDefault); 222 223 /** 224 * Returns the localized title of this polls question in the language. Uses the default language if no localization exists for the requested language. 225 * 226 * @param languageId the ID of the language 227 * @return the localized title of this polls question 228 */ 229 @AutoEscape 230 public String getTitle(String languageId); 231 232 /** 233 * Returns the localized title of this polls question in the language, optionally using the default language if no localization exists for the requested language. 234 * 235 * @param languageId the ID of the language 236 * @param useDefault whether to use the default language if no localization exists for the requested language 237 * @return the localized title of this polls question 238 */ 239 @AutoEscape 240 public String getTitle(String languageId, boolean useDefault); 241 242 @AutoEscape 243 public String getTitleCurrentLanguageId(); 244 245 @AutoEscape 246 public String getTitleCurrentValue(); 247 248 /** 249 * Returns a map of the locales and localized titles of this polls question. 250 * 251 * @return the locales and localized titles of this polls question 252 */ 253 public Map<Locale, String> getTitleMap(); 254 255 /** 256 * Sets the title of this polls question. 257 * 258 * @param title the title of this polls question 259 */ 260 public void setTitle(String title); 261 262 /** 263 * Sets the localized title of this polls question in the language. 264 * 265 * @param title the localized title of this polls question 266 * @param locale the locale of the language 267 */ 268 public void setTitle(String title, Locale locale); 269 270 /** 271 * Sets the localized title of this polls question in the language, and sets the default locale. 272 * 273 * @param title the localized title of this polls question 274 * @param locale the locale of the language 275 * @param defaultLocale the default locale 276 */ 277 public void setTitle(String title, Locale locale, Locale defaultLocale); 278 279 public void setTitleCurrentLanguageId(String languageId); 280 281 /** 282 * Sets the localized titles of this polls question from the map of locales and localized titles. 283 * 284 * @param titleMap the locales and localized titles of this polls question 285 */ 286 public void setTitleMap(Map<Locale, String> titleMap); 287 288 /** 289 * Sets the localized titles of this polls question from the map of locales and localized titles, and sets the default locale. 290 * 291 * @param titleMap the locales and localized titles of this polls question 292 * @param defaultLocale the default locale 293 */ 294 public void setTitleMap(Map<Locale, String> titleMap, Locale defaultLocale); 295 296 /** 297 * Returns the description of this polls question. 298 * 299 * @return the description of this polls question 300 */ 301 public String getDescription(); 302 303 /** 304 * Returns the localized description of this polls question in the language. Uses the default language if no localization exists for the requested language. 305 * 306 * @param locale the locale of the language 307 * @return the localized description of this polls question 308 */ 309 @AutoEscape 310 public String getDescription(Locale locale); 311 312 /** 313 * Returns the localized description of this polls question in the language, optionally using the default language if no localization exists for the requested language. 314 * 315 * @param locale the local of the language 316 * @param useDefault whether to use the default language if no localization exists for the requested language 317 * @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. 318 */ 319 @AutoEscape 320 public String getDescription(Locale locale, boolean useDefault); 321 322 /** 323 * Returns the localized description of this polls question in the language. Uses the default language if no localization exists for the requested language. 324 * 325 * @param languageId the ID of the language 326 * @return the localized description of this polls question 327 */ 328 @AutoEscape 329 public String getDescription(String languageId); 330 331 /** 332 * Returns the localized description of this polls question in the language, optionally using the default language if no localization exists for the requested language. 333 * 334 * @param languageId the ID of the language 335 * @param useDefault whether to use the default language if no localization exists for the requested language 336 * @return the localized description of this polls question 337 */ 338 @AutoEscape 339 public String getDescription(String languageId, boolean useDefault); 340 341 @AutoEscape 342 public String getDescriptionCurrentLanguageId(); 343 344 @AutoEscape 345 public String getDescriptionCurrentValue(); 346 347 /** 348 * Returns a map of the locales and localized descriptions of this polls question. 349 * 350 * @return the locales and localized descriptions of this polls question 351 */ 352 public Map<Locale, String> getDescriptionMap(); 353 354 /** 355 * Sets the description of this polls question. 356 * 357 * @param description the description of this polls question 358 */ 359 public void setDescription(String description); 360 361 /** 362 * Sets the localized description of this polls question in the language. 363 * 364 * @param description the localized description of this polls question 365 * @param locale the locale of the language 366 */ 367 public void setDescription(String description, Locale locale); 368 369 /** 370 * Sets the localized description of this polls question in the language, and sets the default locale. 371 * 372 * @param description the localized description of this polls question 373 * @param locale the locale of the language 374 * @param defaultLocale the default locale 375 */ 376 public void setDescription(String description, Locale locale, 377 Locale defaultLocale); 378 379 public void setDescriptionCurrentLanguageId(String languageId); 380 381 /** 382 * Sets the localized descriptions of this polls question from the map of locales and localized descriptions. 383 * 384 * @param descriptionMap the locales and localized descriptions of this polls question 385 */ 386 public void setDescriptionMap(Map<Locale, String> descriptionMap); 387 388 /** 389 * Sets the localized descriptions of this polls question from the map of locales and localized descriptions, and sets the default locale. 390 * 391 * @param descriptionMap the locales and localized descriptions of this polls question 392 * @param defaultLocale the default locale 393 */ 394 public void setDescriptionMap(Map<Locale, String> descriptionMap, 395 Locale defaultLocale); 396 397 /** 398 * Returns the expiration date of this polls question. 399 * 400 * @return the expiration date of this polls question 401 */ 402 public Date getExpirationDate(); 403 404 /** 405 * Sets the expiration date of this polls question. 406 * 407 * @param expirationDate the expiration date of this polls question 408 */ 409 public void setExpirationDate(Date expirationDate); 410 411 /** 412 * Returns the last vote date of this polls question. 413 * 414 * @return the last vote date of this polls question 415 */ 416 public Date getLastVoteDate(); 417 418 /** 419 * Sets the last vote date of this polls question. 420 * 421 * @param lastVoteDate the last vote date of this polls question 422 */ 423 public void setLastVoteDate(Date lastVoteDate); 424 425 public boolean isNew(); 426 427 public void setNew(boolean n); 428 429 public boolean isCachedModel(); 430 431 public void setCachedModel(boolean cachedModel); 432 433 public boolean isEscapedModel(); 434 435 public Serializable getPrimaryKeyObj(); 436 437 public void setPrimaryKeyObj(Serializable primaryKeyObj); 438 439 public ExpandoBridge getExpandoBridge(); 440 441 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 442 443 public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) 444 throws LocaleException; 445 446 public Object clone(); 447 448 public int compareTo(PollsQuestion pollsQuestion); 449 450 public int hashCode(); 451 452 public CacheModel<PollsQuestion> toCacheModel(); 453 454 public PollsQuestion toEscapedModel(); 455 456 public PollsQuestion toUnescapedModel(); 457 458 public String toString(); 459 460 public String toXmlString(); 461 }