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.StagedGroupedModel; 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 StagedGroupedModel { 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 @Override 075 public String getUuid(); 076 077 /** 078 * Sets the uuid of this polls question. 079 * 080 * @param uuid the uuid of this polls question 081 */ 082 @Override 083 public void setUuid(String uuid); 084 085 /** 086 * Returns the question ID of this polls question. 087 * 088 * @return the question ID of this polls question 089 */ 090 public long getQuestionId(); 091 092 /** 093 * Sets the question ID of this polls question. 094 * 095 * @param questionId the question ID of this polls question 096 */ 097 public void setQuestionId(long questionId); 098 099 /** 100 * Returns the group ID of this polls question. 101 * 102 * @return the group ID of this polls question 103 */ 104 @Override 105 public long getGroupId(); 106 107 /** 108 * Sets the group ID of this polls question. 109 * 110 * @param groupId the group ID of this polls question 111 */ 112 @Override 113 public void setGroupId(long groupId); 114 115 /** 116 * Returns the company ID of this polls question. 117 * 118 * @return the company ID of this polls question 119 */ 120 @Override 121 public long getCompanyId(); 122 123 /** 124 * Sets the company ID of this polls question. 125 * 126 * @param companyId the company ID of this polls question 127 */ 128 @Override 129 public void setCompanyId(long companyId); 130 131 /** 132 * Returns the user ID of this polls question. 133 * 134 * @return the user ID of this polls question 135 */ 136 @Override 137 public long getUserId(); 138 139 /** 140 * Sets the user ID of this polls question. 141 * 142 * @param userId the user ID of this polls question 143 */ 144 @Override 145 public void setUserId(long userId); 146 147 /** 148 * Returns the user uuid of this polls question. 149 * 150 * @return the user uuid of this polls question 151 * @throws SystemException if a system exception occurred 152 */ 153 @Override 154 public String getUserUuid() throws SystemException; 155 156 /** 157 * Sets the user uuid of this polls question. 158 * 159 * @param userUuid the user uuid of this polls question 160 */ 161 @Override 162 public void setUserUuid(String userUuid); 163 164 /** 165 * Returns the user name of this polls question. 166 * 167 * @return the user name of this polls question 168 */ 169 @AutoEscape 170 @Override 171 public String getUserName(); 172 173 /** 174 * Sets the user name of this polls question. 175 * 176 * @param userName the user name of this polls question 177 */ 178 @Override 179 public void setUserName(String userName); 180 181 /** 182 * Returns the create date of this polls question. 183 * 184 * @return the create date of this polls question 185 */ 186 @Override 187 public Date getCreateDate(); 188 189 /** 190 * Sets the create date of this polls question. 191 * 192 * @param createDate the create date of this polls question 193 */ 194 @Override 195 public void setCreateDate(Date createDate); 196 197 /** 198 * Returns the modified date of this polls question. 199 * 200 * @return the modified date of this polls question 201 */ 202 @Override 203 public Date getModifiedDate(); 204 205 /** 206 * Sets the modified date of this polls question. 207 * 208 * @param modifiedDate the modified date of this polls question 209 */ 210 @Override 211 public void setModifiedDate(Date modifiedDate); 212 213 /** 214 * Returns the title of this polls question. 215 * 216 * @return the title of this polls question 217 */ 218 public String getTitle(); 219 220 /** 221 * Returns the localized title of this polls question in the language. Uses the default language if no localization exists for the requested language. 222 * 223 * @param locale the locale of the language 224 * @return the localized title of this polls question 225 */ 226 @AutoEscape 227 public String getTitle(Locale locale); 228 229 /** 230 * Returns the localized title of this polls question in the language, optionally using the default language if no localization exists for the requested language. 231 * 232 * @param locale the local of the language 233 * @param useDefault whether to use the default language if no localization exists for the requested language 234 * @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. 235 */ 236 @AutoEscape 237 public String getTitle(Locale locale, boolean useDefault); 238 239 /** 240 * Returns the localized title of this polls question in the language. Uses the default language if no localization exists for the requested language. 241 * 242 * @param languageId the ID of the language 243 * @return the localized title of this polls question 244 */ 245 @AutoEscape 246 public String getTitle(String languageId); 247 248 /** 249 * Returns the localized title of this polls question in the language, optionally using the default language if no localization exists for the requested language. 250 * 251 * @param languageId the ID of the language 252 * @param useDefault whether to use the default language if no localization exists for the requested language 253 * @return the localized title of this polls question 254 */ 255 @AutoEscape 256 public String getTitle(String languageId, boolean useDefault); 257 258 @AutoEscape 259 public String getTitleCurrentLanguageId(); 260 261 @AutoEscape 262 public String getTitleCurrentValue(); 263 264 /** 265 * Returns a map of the locales and localized titles of this polls question. 266 * 267 * @return the locales and localized titles of this polls question 268 */ 269 public Map<Locale, String> getTitleMap(); 270 271 /** 272 * Sets the title of this polls question. 273 * 274 * @param title the title of this polls question 275 */ 276 public void setTitle(String title); 277 278 /** 279 * Sets the localized title of this polls question in the language. 280 * 281 * @param title the localized title of this polls question 282 * @param locale the locale of the language 283 */ 284 public void setTitle(String title, Locale locale); 285 286 /** 287 * Sets the localized title of this polls question in the language, and sets the default locale. 288 * 289 * @param title the localized title of this polls question 290 * @param locale the locale of the language 291 * @param defaultLocale the default locale 292 */ 293 public void setTitle(String title, Locale locale, Locale defaultLocale); 294 295 public void setTitleCurrentLanguageId(String languageId); 296 297 /** 298 * Sets the localized titles of this polls question from the map of locales and localized titles. 299 * 300 * @param titleMap the locales and localized titles of this polls question 301 */ 302 public void setTitleMap(Map<Locale, String> titleMap); 303 304 /** 305 * Sets the localized titles of this polls question from the map of locales and localized titles, and sets the default locale. 306 * 307 * @param titleMap the locales and localized titles of this polls question 308 * @param defaultLocale the default locale 309 */ 310 public void setTitleMap(Map<Locale, String> titleMap, Locale defaultLocale); 311 312 /** 313 * Returns the description of this polls question. 314 * 315 * @return the description of this polls question 316 */ 317 public String getDescription(); 318 319 /** 320 * Returns the localized description of this polls question in the language. Uses the default language if no localization exists for the requested language. 321 * 322 * @param locale the locale of the language 323 * @return the localized description of this polls question 324 */ 325 @AutoEscape 326 public String getDescription(Locale locale); 327 328 /** 329 * Returns the localized description of this polls question in the language, optionally using the default language if no localization exists for the requested language. 330 * 331 * @param locale the local of the language 332 * @param useDefault whether to use the default language if no localization exists for the requested language 333 * @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. 334 */ 335 @AutoEscape 336 public String getDescription(Locale locale, boolean useDefault); 337 338 /** 339 * Returns the localized description of this polls question in the language. Uses the default language if no localization exists for the requested language. 340 * 341 * @param languageId the ID of the language 342 * @return the localized description of this polls question 343 */ 344 @AutoEscape 345 public String getDescription(String languageId); 346 347 /** 348 * Returns the localized description of this polls question in the language, optionally using the default language if no localization exists for the requested language. 349 * 350 * @param languageId the ID of the language 351 * @param useDefault whether to use the default language if no localization exists for the requested language 352 * @return the localized description of this polls question 353 */ 354 @AutoEscape 355 public String getDescription(String languageId, boolean useDefault); 356 357 @AutoEscape 358 public String getDescriptionCurrentLanguageId(); 359 360 @AutoEscape 361 public String getDescriptionCurrentValue(); 362 363 /** 364 * Returns a map of the locales and localized descriptions of this polls question. 365 * 366 * @return the locales and localized descriptions of this polls question 367 */ 368 public Map<Locale, String> getDescriptionMap(); 369 370 /** 371 * Sets the description of this polls question. 372 * 373 * @param description the description of this polls question 374 */ 375 public void setDescription(String description); 376 377 /** 378 * Sets the localized description of this polls question in the language. 379 * 380 * @param description the localized description of this polls question 381 * @param locale the locale of the language 382 */ 383 public void setDescription(String description, Locale locale); 384 385 /** 386 * Sets the localized description of this polls question in the language, and sets the default locale. 387 * 388 * @param description the localized description of this polls question 389 * @param locale the locale of the language 390 * @param defaultLocale the default locale 391 */ 392 public void setDescription(String description, Locale locale, 393 Locale defaultLocale); 394 395 public void setDescriptionCurrentLanguageId(String languageId); 396 397 /** 398 * Sets the localized descriptions of this polls question from the map of locales and localized descriptions. 399 * 400 * @param descriptionMap the locales and localized descriptions of this polls question 401 */ 402 public void setDescriptionMap(Map<Locale, String> descriptionMap); 403 404 /** 405 * Sets the localized descriptions of this polls question from the map of locales and localized descriptions, and sets the default locale. 406 * 407 * @param descriptionMap the locales and localized descriptions of this polls question 408 * @param defaultLocale the default locale 409 */ 410 public void setDescriptionMap(Map<Locale, String> descriptionMap, 411 Locale defaultLocale); 412 413 /** 414 * Returns the expiration date of this polls question. 415 * 416 * @return the expiration date of this polls question 417 */ 418 public Date getExpirationDate(); 419 420 /** 421 * Sets the expiration date of this polls question. 422 * 423 * @param expirationDate the expiration date of this polls question 424 */ 425 public void setExpirationDate(Date expirationDate); 426 427 /** 428 * Returns the last vote date of this polls question. 429 * 430 * @return the last vote date of this polls question 431 */ 432 public Date getLastVoteDate(); 433 434 /** 435 * Sets the last vote date of this polls question. 436 * 437 * @param lastVoteDate the last vote date of this polls question 438 */ 439 public void setLastVoteDate(Date lastVoteDate); 440 441 @Override 442 public boolean isNew(); 443 444 @Override 445 public void setNew(boolean n); 446 447 @Override 448 public boolean isCachedModel(); 449 450 @Override 451 public void setCachedModel(boolean cachedModel); 452 453 @Override 454 public boolean isEscapedModel(); 455 456 @Override 457 public Serializable getPrimaryKeyObj(); 458 459 @Override 460 public void setPrimaryKeyObj(Serializable primaryKeyObj); 461 462 @Override 463 public ExpandoBridge getExpandoBridge(); 464 465 @Override 466 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 467 468 @Override 469 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 470 471 @Override 472 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 473 474 public String[] getAvailableLanguageIds(); 475 476 public String getDefaultLanguageId(); 477 478 public void prepareLocalizedFieldsForImport() throws LocaleException; 479 480 public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) 481 throws LocaleException; 482 483 @Override 484 public Object clone(); 485 486 @Override 487 public int compareTo(PollsQuestion pollsQuestion); 488 489 @Override 490 public int hashCode(); 491 492 @Override 493 public CacheModel<PollsQuestion> toCacheModel(); 494 495 @Override 496 public PollsQuestion toEscapedModel(); 497 498 @Override 499 public PollsQuestion toUnescapedModel(); 500 501 @Override 502 public String toString(); 503 504 @Override 505 public String toXmlString(); 506 }