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.announcements.model; 016 017 import com.liferay.portal.kernel.bean.AutoEscape; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.model.AttachedModel; 020 import com.liferay.portal.model.BaseModel; 021 import com.liferay.portal.model.CacheModel; 022 import com.liferay.portal.model.StagedAuditedModel; 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 031 /** 032 * The base model interface for the AnnouncementsEntry service. Represents a row in the "AnnouncementsEntry" database table, with each column mapped to a property of this class. 033 * 034 * <p> 035 * This interface and its corresponding implementation {@link com.liferay.portlet.announcements.model.impl.AnnouncementsEntryModelImpl} 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.announcements.model.impl.AnnouncementsEntryImpl}. 036 * </p> 037 * 038 * @author Brian Wing Shun Chan 039 * @see AnnouncementsEntry 040 * @see com.liferay.portlet.announcements.model.impl.AnnouncementsEntryImpl 041 * @see com.liferay.portlet.announcements.model.impl.AnnouncementsEntryModelImpl 042 * @generated 043 */ 044 public interface AnnouncementsEntryModel extends AttachedModel, 045 BaseModel<AnnouncementsEntry>, StagedAuditedModel { 046 /* 047 * NOTE FOR DEVELOPERS: 048 * 049 * Never modify or reference this interface directly. All methods that expect a announcements entry model instance should use the {@link AnnouncementsEntry} interface instead. 050 */ 051 052 /** 053 * Returns the primary key of this announcements entry. 054 * 055 * @return the primary key of this announcements entry 056 */ 057 public long getPrimaryKey(); 058 059 /** 060 * Sets the primary key of this announcements entry. 061 * 062 * @param primaryKey the primary key of this announcements entry 063 */ 064 public void setPrimaryKey(long primaryKey); 065 066 /** 067 * Returns the uuid of this announcements entry. 068 * 069 * @return the uuid of this announcements entry 070 */ 071 @AutoEscape 072 @Override 073 public String getUuid(); 074 075 /** 076 * Sets the uuid of this announcements entry. 077 * 078 * @param uuid the uuid of this announcements entry 079 */ 080 @Override 081 public void setUuid(String uuid); 082 083 /** 084 * Returns the entry ID of this announcements entry. 085 * 086 * @return the entry ID of this announcements entry 087 */ 088 public long getEntryId(); 089 090 /** 091 * Sets the entry ID of this announcements entry. 092 * 093 * @param entryId the entry ID of this announcements entry 094 */ 095 public void setEntryId(long entryId); 096 097 /** 098 * Returns the company ID of this announcements entry. 099 * 100 * @return the company ID of this announcements entry 101 */ 102 @Override 103 public long getCompanyId(); 104 105 /** 106 * Sets the company ID of this announcements entry. 107 * 108 * @param companyId the company ID of this announcements entry 109 */ 110 @Override 111 public void setCompanyId(long companyId); 112 113 /** 114 * Returns the user ID of this announcements entry. 115 * 116 * @return the user ID of this announcements entry 117 */ 118 @Override 119 public long getUserId(); 120 121 /** 122 * Sets the user ID of this announcements entry. 123 * 124 * @param userId the user ID of this announcements entry 125 */ 126 @Override 127 public void setUserId(long userId); 128 129 /** 130 * Returns the user uuid of this announcements entry. 131 * 132 * @return the user uuid of this announcements entry 133 * @throws SystemException if a system exception occurred 134 */ 135 @Override 136 public String getUserUuid() throws SystemException; 137 138 /** 139 * Sets the user uuid of this announcements entry. 140 * 141 * @param userUuid the user uuid of this announcements entry 142 */ 143 @Override 144 public void setUserUuid(String userUuid); 145 146 /** 147 * Returns the user name of this announcements entry. 148 * 149 * @return the user name of this announcements entry 150 */ 151 @AutoEscape 152 @Override 153 public String getUserName(); 154 155 /** 156 * Sets the user name of this announcements entry. 157 * 158 * @param userName the user name of this announcements entry 159 */ 160 @Override 161 public void setUserName(String userName); 162 163 /** 164 * Returns the create date of this announcements entry. 165 * 166 * @return the create date of this announcements entry 167 */ 168 @Override 169 public Date getCreateDate(); 170 171 /** 172 * Sets the create date of this announcements entry. 173 * 174 * @param createDate the create date of this announcements entry 175 */ 176 @Override 177 public void setCreateDate(Date createDate); 178 179 /** 180 * Returns the modified date of this announcements entry. 181 * 182 * @return the modified date of this announcements entry 183 */ 184 @Override 185 public Date getModifiedDate(); 186 187 /** 188 * Sets the modified date of this announcements entry. 189 * 190 * @param modifiedDate the modified date of this announcements entry 191 */ 192 @Override 193 public void setModifiedDate(Date modifiedDate); 194 195 /** 196 * Returns the fully qualified class name of this announcements entry. 197 * 198 * @return the fully qualified class name of this announcements entry 199 */ 200 @Override 201 public String getClassName(); 202 203 public void setClassName(String className); 204 205 /** 206 * Returns the class name ID of this announcements entry. 207 * 208 * @return the class name ID of this announcements entry 209 */ 210 @Override 211 public long getClassNameId(); 212 213 /** 214 * Sets the class name ID of this announcements entry. 215 * 216 * @param classNameId the class name ID of this announcements entry 217 */ 218 @Override 219 public void setClassNameId(long classNameId); 220 221 /** 222 * Returns the class p k of this announcements entry. 223 * 224 * @return the class p k of this announcements entry 225 */ 226 @Override 227 public long getClassPK(); 228 229 /** 230 * Sets the class p k of this announcements entry. 231 * 232 * @param classPK the class p k of this announcements entry 233 */ 234 @Override 235 public void setClassPK(long classPK); 236 237 /** 238 * Returns the title of this announcements entry. 239 * 240 * @return the title of this announcements entry 241 */ 242 @AutoEscape 243 public String getTitle(); 244 245 /** 246 * Sets the title of this announcements entry. 247 * 248 * @param title the title of this announcements entry 249 */ 250 public void setTitle(String title); 251 252 /** 253 * Returns the content of this announcements entry. 254 * 255 * @return the content of this announcements entry 256 */ 257 @AutoEscape 258 public String getContent(); 259 260 /** 261 * Sets the content of this announcements entry. 262 * 263 * @param content the content of this announcements entry 264 */ 265 public void setContent(String content); 266 267 /** 268 * Returns the url of this announcements entry. 269 * 270 * @return the url of this announcements entry 271 */ 272 @AutoEscape 273 public String getUrl(); 274 275 /** 276 * Sets the url of this announcements entry. 277 * 278 * @param url the url of this announcements entry 279 */ 280 public void setUrl(String url); 281 282 /** 283 * Returns the type of this announcements entry. 284 * 285 * @return the type of this announcements entry 286 */ 287 @AutoEscape 288 public String getType(); 289 290 /** 291 * Sets the type of this announcements entry. 292 * 293 * @param type the type of this announcements entry 294 */ 295 public void setType(String type); 296 297 /** 298 * Returns the display date of this announcements entry. 299 * 300 * @return the display date of this announcements entry 301 */ 302 public Date getDisplayDate(); 303 304 /** 305 * Sets the display date of this announcements entry. 306 * 307 * @param displayDate the display date of this announcements entry 308 */ 309 public void setDisplayDate(Date displayDate); 310 311 /** 312 * Returns the expiration date of this announcements entry. 313 * 314 * @return the expiration date of this announcements entry 315 */ 316 public Date getExpirationDate(); 317 318 /** 319 * Sets the expiration date of this announcements entry. 320 * 321 * @param expirationDate the expiration date of this announcements entry 322 */ 323 public void setExpirationDate(Date expirationDate); 324 325 /** 326 * Returns the priority of this announcements entry. 327 * 328 * @return the priority of this announcements entry 329 */ 330 public int getPriority(); 331 332 /** 333 * Sets the priority of this announcements entry. 334 * 335 * @param priority the priority of this announcements entry 336 */ 337 public void setPriority(int priority); 338 339 /** 340 * Returns the alert of this announcements entry. 341 * 342 * @return the alert of this announcements entry 343 */ 344 public boolean getAlert(); 345 346 /** 347 * Returns <code>true</code> if this announcements entry is alert. 348 * 349 * @return <code>true</code> if this announcements entry is alert; <code>false</code> otherwise 350 */ 351 public boolean isAlert(); 352 353 /** 354 * Sets whether this announcements entry is alert. 355 * 356 * @param alert the alert of this announcements entry 357 */ 358 public void setAlert(boolean alert); 359 360 @Override 361 public boolean isNew(); 362 363 @Override 364 public void setNew(boolean n); 365 366 @Override 367 public boolean isCachedModel(); 368 369 @Override 370 public void setCachedModel(boolean cachedModel); 371 372 @Override 373 public boolean isEscapedModel(); 374 375 @Override 376 public Serializable getPrimaryKeyObj(); 377 378 @Override 379 public void setPrimaryKeyObj(Serializable primaryKeyObj); 380 381 @Override 382 public ExpandoBridge getExpandoBridge(); 383 384 @Override 385 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 386 387 @Override 388 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 389 390 @Override 391 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 392 393 @Override 394 public Object clone(); 395 396 @Override 397 public int compareTo(AnnouncementsEntry announcementsEntry); 398 399 @Override 400 public int hashCode(); 401 402 @Override 403 public CacheModel<AnnouncementsEntry> toCacheModel(); 404 405 @Override 406 public AnnouncementsEntry toEscapedModel(); 407 408 @Override 409 public AnnouncementsEntry toUnescapedModel(); 410 411 @Override 412 public String toString(); 413 414 @Override 415 public String toXmlString(); 416 }