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