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