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