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 PollsChoice service. Represents a row in the "PollsChoice" 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.PollsChoiceModelImpl} 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.PollsChoiceImpl}. 040 * </p> 041 * 042 * @author Brian Wing Shun Chan 043 * @see PollsChoice 044 * @see com.liferay.portlet.polls.model.impl.PollsChoiceImpl 045 * @see com.liferay.portlet.polls.model.impl.PollsChoiceModelImpl 046 * @generated 047 */ 048 @ProviderType 049 public interface PollsChoiceModel extends BaseModel<PollsChoice>, 050 StagedGroupedModel { 051 /* 052 * NOTE FOR DEVELOPERS: 053 * 054 * Never modify or reference this interface directly. All methods that expect a polls choice model instance should use the {@link PollsChoice} interface instead. 055 */ 056 057 /** 058 * Returns the primary key of this polls choice. 059 * 060 * @return the primary key of this polls choice 061 */ 062 public long getPrimaryKey(); 063 064 /** 065 * Sets the primary key of this polls choice. 066 * 067 * @param primaryKey the primary key of this polls choice 068 */ 069 public void setPrimaryKey(long primaryKey); 070 071 /** 072 * Returns the uuid of this polls choice. 073 * 074 * @return the uuid of this polls choice 075 */ 076 @AutoEscape 077 @Override 078 public String getUuid(); 079 080 /** 081 * Sets the uuid of this polls choice. 082 * 083 * @param uuid the uuid of this polls choice 084 */ 085 @Override 086 public void setUuid(String uuid); 087 088 /** 089 * Returns the choice ID of this polls choice. 090 * 091 * @return the choice ID of this polls choice 092 */ 093 public long getChoiceId(); 094 095 /** 096 * Sets the choice ID of this polls choice. 097 * 098 * @param choiceId the choice ID of this polls choice 099 */ 100 public void setChoiceId(long choiceId); 101 102 /** 103 * Returns the group ID of this polls choice. 104 * 105 * @return the group ID of this polls choice 106 */ 107 @Override 108 public long getGroupId(); 109 110 /** 111 * Sets the group ID of this polls choice. 112 * 113 * @param groupId the group ID of this polls choice 114 */ 115 @Override 116 public void setGroupId(long groupId); 117 118 /** 119 * Returns the company ID of this polls choice. 120 * 121 * @return the company ID of this polls choice 122 */ 123 @Override 124 public long getCompanyId(); 125 126 /** 127 * Sets the company ID of this polls choice. 128 * 129 * @param companyId the company ID of this polls choice 130 */ 131 @Override 132 public void setCompanyId(long companyId); 133 134 /** 135 * Returns the user ID of this polls choice. 136 * 137 * @return the user ID of this polls choice 138 */ 139 @Override 140 public long getUserId(); 141 142 /** 143 * Sets the user ID of this polls choice. 144 * 145 * @param userId the user ID of this polls choice 146 */ 147 @Override 148 public void setUserId(long userId); 149 150 /** 151 * Returns the user uuid of this polls choice. 152 * 153 * @return the user uuid of this polls choice 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 choice. 161 * 162 * @param userUuid the user uuid of this polls choice 163 */ 164 @Override 165 public void setUserUuid(String userUuid); 166 167 /** 168 * Returns the user name of this polls choice. 169 * 170 * @return the user name of this polls choice 171 */ 172 @AutoEscape 173 @Override 174 public String getUserName(); 175 176 /** 177 * Sets the user name of this polls choice. 178 * 179 * @param userName the user name of this polls choice 180 */ 181 @Override 182 public void setUserName(String userName); 183 184 /** 185 * Returns the create date of this polls choice. 186 * 187 * @return the create date of this polls choice 188 */ 189 @Override 190 public Date getCreateDate(); 191 192 /** 193 * Sets the create date of this polls choice. 194 * 195 * @param createDate the create date of this polls choice 196 */ 197 @Override 198 public void setCreateDate(Date createDate); 199 200 /** 201 * Returns the modified date of this polls choice. 202 * 203 * @return the modified date of this polls choice 204 */ 205 @Override 206 public Date getModifiedDate(); 207 208 /** 209 * Sets the modified date of this polls choice. 210 * 211 * @param modifiedDate the modified date of this polls choice 212 */ 213 @Override 214 public void setModifiedDate(Date modifiedDate); 215 216 /** 217 * Returns the question ID of this polls choice. 218 * 219 * @return the question ID of this polls choice 220 */ 221 public long getQuestionId(); 222 223 /** 224 * Sets the question ID of this polls choice. 225 * 226 * @param questionId the question ID of this polls choice 227 */ 228 public void setQuestionId(long questionId); 229 230 /** 231 * Returns the name of this polls choice. 232 * 233 * @return the name of this polls choice 234 */ 235 @AutoEscape 236 public String getName(); 237 238 /** 239 * Sets the name of this polls choice. 240 * 241 * @param name the name of this polls choice 242 */ 243 public void setName(String name); 244 245 /** 246 * Returns the description of this polls choice. 247 * 248 * @return the description of this polls choice 249 */ 250 public String getDescription(); 251 252 /** 253 * Returns the localized description of this polls choice in the language. Uses the default language if no localization exists for the requested language. 254 * 255 * @param locale the locale of the language 256 * @return the localized description of this polls choice 257 */ 258 @AutoEscape 259 public String getDescription(Locale locale); 260 261 /** 262 * Returns the localized description of this polls choice in the language, optionally using the default language if no localization exists for the requested language. 263 * 264 * @param locale the local of the language 265 * @param useDefault whether to use the default language if no localization exists for the requested language 266 * @return the localized description of this polls choice. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 267 */ 268 @AutoEscape 269 public String getDescription(Locale locale, boolean useDefault); 270 271 /** 272 * Returns the localized description of this polls choice in the language. Uses the default language if no localization exists for the requested language. 273 * 274 * @param languageId the ID of the language 275 * @return the localized description of this polls choice 276 */ 277 @AutoEscape 278 public String getDescription(String languageId); 279 280 /** 281 * Returns the localized description of this polls choice in the language, optionally using the default language if no localization exists for the requested language. 282 * 283 * @param languageId the ID of the language 284 * @param useDefault whether to use the default language if no localization exists for the requested language 285 * @return the localized description of this polls choice 286 */ 287 @AutoEscape 288 public String getDescription(String languageId, boolean useDefault); 289 290 @AutoEscape 291 public String getDescriptionCurrentLanguageId(); 292 293 @AutoEscape 294 public String getDescriptionCurrentValue(); 295 296 /** 297 * Returns a map of the locales and localized descriptions of this polls choice. 298 * 299 * @return the locales and localized descriptions of this polls choice 300 */ 301 public Map<Locale, String> getDescriptionMap(); 302 303 /** 304 * Sets the description of this polls choice. 305 * 306 * @param description the description of this polls choice 307 */ 308 public void setDescription(String description); 309 310 /** 311 * Sets the localized description of this polls choice in the language. 312 * 313 * @param description the localized description of this polls choice 314 * @param locale the locale of the language 315 */ 316 public void setDescription(String description, Locale locale); 317 318 /** 319 * Sets the localized description of this polls choice in the language, and sets the default locale. 320 * 321 * @param description the localized description of this polls choice 322 * @param locale the locale of the language 323 * @param defaultLocale the default locale 324 */ 325 public void setDescription(String description, Locale locale, 326 Locale defaultLocale); 327 328 public void setDescriptionCurrentLanguageId(String languageId); 329 330 /** 331 * Sets the localized descriptions of this polls choice from the map of locales and localized descriptions. 332 * 333 * @param descriptionMap the locales and localized descriptions of this polls choice 334 */ 335 public void setDescriptionMap(Map<Locale, String> descriptionMap); 336 337 /** 338 * Sets the localized descriptions of this polls choice from the map of locales and localized descriptions, and sets the default locale. 339 * 340 * @param descriptionMap the locales and localized descriptions of this polls choice 341 * @param defaultLocale the default locale 342 */ 343 public void setDescriptionMap(Map<Locale, String> descriptionMap, 344 Locale defaultLocale); 345 346 @Override 347 public boolean isNew(); 348 349 @Override 350 public void setNew(boolean n); 351 352 @Override 353 public boolean isCachedModel(); 354 355 @Override 356 public void setCachedModel(boolean cachedModel); 357 358 @Override 359 public boolean isEscapedModel(); 360 361 @Override 362 public Serializable getPrimaryKeyObj(); 363 364 @Override 365 public void setPrimaryKeyObj(Serializable primaryKeyObj); 366 367 @Override 368 public ExpandoBridge getExpandoBridge(); 369 370 @Override 371 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 372 373 @Override 374 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 375 376 @Override 377 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 378 379 public String[] getAvailableLanguageIds(); 380 381 public String getDefaultLanguageId(); 382 383 public void prepareLocalizedFieldsForImport() throws LocaleException; 384 385 public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) 386 throws LocaleException; 387 388 @Override 389 public Object clone(); 390 391 @Override 392 public int compareTo(PollsChoice pollsChoice); 393 394 @Override 395 public int hashCode(); 396 397 @Override 398 public CacheModel<PollsChoice> toCacheModel(); 399 400 @Override 401 public PollsChoice toEscapedModel(); 402 403 @Override 404 public PollsChoice toUnescapedModel(); 405 406 @Override 407 public String toString(); 408 409 @Override 410 public String toXmlString(); 411 }