001 /** 002 * Copyright (c) 2000-present 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.calendar.model; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.bean.AutoEscape; 020 import com.liferay.portal.model.BaseModel; 021 import com.liferay.portal.model.CacheModel; 022 import com.liferay.portal.model.GroupedModel; 023 import com.liferay.portal.model.StagedAuditedModel; 024 import com.liferay.portal.service.ServiceContext; 025 026 import com.liferay.portlet.expando.model.ExpandoBridge; 027 028 import java.io.Serializable; 029 030 import java.util.Date; 031 032 /** 033 * The base model interface for the CalEvent service. Represents a row in the "CalEvent" 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.calendar.model.impl.CalEventModelImpl} 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.calendar.model.impl.CalEventImpl}. 037 * </p> 038 * 039 * @author Brian Wing Shun Chan 040 * @see CalEvent 041 * @see com.liferay.portlet.calendar.model.impl.CalEventImpl 042 * @see com.liferay.portlet.calendar.model.impl.CalEventModelImpl 043 * @deprecated As of 7.0.0, with no direct replacement 044 * @generated 045 */ 046 @Deprecated 047 @ProviderType 048 public interface CalEventModel extends BaseModel<CalEvent>, GroupedModel, 049 StagedAuditedModel { 050 /* 051 * NOTE FOR DEVELOPERS: 052 * 053 * Never modify or reference this interface directly. All methods that expect a cal event model instance should use the {@link CalEvent} interface instead. 054 */ 055 056 /** 057 * Returns the primary key of this cal event. 058 * 059 * @return the primary key of this cal event 060 */ 061 public long getPrimaryKey(); 062 063 /** 064 * Sets the primary key of this cal event. 065 * 066 * @param primaryKey the primary key of this cal event 067 */ 068 public void setPrimaryKey(long primaryKey); 069 070 /** 071 * Returns the uuid of this cal event. 072 * 073 * @return the uuid of this cal event 074 */ 075 @AutoEscape 076 @Override 077 public String getUuid(); 078 079 /** 080 * Sets the uuid of this cal event. 081 * 082 * @param uuid the uuid of this cal event 083 */ 084 @Override 085 public void setUuid(String uuid); 086 087 /** 088 * Returns the event ID of this cal event. 089 * 090 * @return the event ID of this cal event 091 */ 092 public long getEventId(); 093 094 /** 095 * Sets the event ID of this cal event. 096 * 097 * @param eventId the event ID of this cal event 098 */ 099 public void setEventId(long eventId); 100 101 /** 102 * Returns the group ID of this cal event. 103 * 104 * @return the group ID of this cal event 105 */ 106 @Override 107 public long getGroupId(); 108 109 /** 110 * Sets the group ID of this cal event. 111 * 112 * @param groupId the group ID of this cal event 113 */ 114 @Override 115 public void setGroupId(long groupId); 116 117 /** 118 * Returns the company ID of this cal event. 119 * 120 * @return the company ID of this cal event 121 */ 122 @Override 123 public long getCompanyId(); 124 125 /** 126 * Sets the company ID of this cal event. 127 * 128 * @param companyId the company ID of this cal event 129 */ 130 @Override 131 public void setCompanyId(long companyId); 132 133 /** 134 * Returns the user ID of this cal event. 135 * 136 * @return the user ID of this cal event 137 */ 138 @Override 139 public long getUserId(); 140 141 /** 142 * Sets the user ID of this cal event. 143 * 144 * @param userId the user ID of this cal event 145 */ 146 @Override 147 public void setUserId(long userId); 148 149 /** 150 * Returns the user uuid of this cal event. 151 * 152 * @return the user uuid of this cal event 153 */ 154 @Override 155 public String getUserUuid(); 156 157 /** 158 * Sets the user uuid of this cal event. 159 * 160 * @param userUuid the user uuid of this cal event 161 */ 162 @Override 163 public void setUserUuid(String userUuid); 164 165 /** 166 * Returns the user name of this cal event. 167 * 168 * @return the user name of this cal event 169 */ 170 @AutoEscape 171 @Override 172 public String getUserName(); 173 174 /** 175 * Sets the user name of this cal event. 176 * 177 * @param userName the user name of this cal event 178 */ 179 @Override 180 public void setUserName(String userName); 181 182 /** 183 * Returns the create date of this cal event. 184 * 185 * @return the create date of this cal event 186 */ 187 @Override 188 public Date getCreateDate(); 189 190 /** 191 * Sets the create date of this cal event. 192 * 193 * @param createDate the create date of this cal event 194 */ 195 @Override 196 public void setCreateDate(Date createDate); 197 198 /** 199 * Returns the modified date of this cal event. 200 * 201 * @return the modified date of this cal event 202 */ 203 @Override 204 public Date getModifiedDate(); 205 206 /** 207 * Sets the modified date of this cal event. 208 * 209 * @param modifiedDate the modified date of this cal event 210 */ 211 @Override 212 public void setModifiedDate(Date modifiedDate); 213 214 /** 215 * Returns the title of this cal event. 216 * 217 * @return the title of this cal event 218 */ 219 @AutoEscape 220 public String getTitle(); 221 222 /** 223 * Sets the title of this cal event. 224 * 225 * @param title the title of this cal event 226 */ 227 public void setTitle(String title); 228 229 /** 230 * Returns the description of this cal event. 231 * 232 * @return the description of this cal event 233 */ 234 @AutoEscape 235 public String getDescription(); 236 237 /** 238 * Sets the description of this cal event. 239 * 240 * @param description the description of this cal event 241 */ 242 public void setDescription(String description); 243 244 /** 245 * Returns the location of this cal event. 246 * 247 * @return the location of this cal event 248 */ 249 @AutoEscape 250 public String getLocation(); 251 252 /** 253 * Sets the location of this cal event. 254 * 255 * @param location the location of this cal event 256 */ 257 public void setLocation(String location); 258 259 /** 260 * Returns the start date of this cal event. 261 * 262 * @return the start date of this cal event 263 */ 264 public Date getStartDate(); 265 266 /** 267 * Sets the start date of this cal event. 268 * 269 * @param startDate the start date of this cal event 270 */ 271 public void setStartDate(Date startDate); 272 273 /** 274 * Returns the end date of this cal event. 275 * 276 * @return the end date of this cal event 277 */ 278 public Date getEndDate(); 279 280 /** 281 * Sets the end date of this cal event. 282 * 283 * @param endDate the end date of this cal event 284 */ 285 public void setEndDate(Date endDate); 286 287 /** 288 * Returns the duration hour of this cal event. 289 * 290 * @return the duration hour of this cal event 291 */ 292 public int getDurationHour(); 293 294 /** 295 * Sets the duration hour of this cal event. 296 * 297 * @param durationHour the duration hour of this cal event 298 */ 299 public void setDurationHour(int durationHour); 300 301 /** 302 * Returns the duration minute of this cal event. 303 * 304 * @return the duration minute of this cal event 305 */ 306 public int getDurationMinute(); 307 308 /** 309 * Sets the duration minute of this cal event. 310 * 311 * @param durationMinute the duration minute of this cal event 312 */ 313 public void setDurationMinute(int durationMinute); 314 315 /** 316 * Returns the all day of this cal event. 317 * 318 * @return the all day of this cal event 319 */ 320 public boolean getAllDay(); 321 322 /** 323 * Returns <code>true</code> if this cal event is all day. 324 * 325 * @return <code>true</code> if this cal event is all day; <code>false</code> otherwise 326 */ 327 public boolean isAllDay(); 328 329 /** 330 * Sets whether this cal event is all day. 331 * 332 * @param allDay the all day of this cal event 333 */ 334 public void setAllDay(boolean allDay); 335 336 /** 337 * Returns the time zone sensitive of this cal event. 338 * 339 * @return the time zone sensitive of this cal event 340 */ 341 public boolean getTimeZoneSensitive(); 342 343 /** 344 * Returns <code>true</code> if this cal event is time zone sensitive. 345 * 346 * @return <code>true</code> if this cal event is time zone sensitive; <code>false</code> otherwise 347 */ 348 public boolean isTimeZoneSensitive(); 349 350 /** 351 * Sets whether this cal event is time zone sensitive. 352 * 353 * @param timeZoneSensitive the time zone sensitive of this cal event 354 */ 355 public void setTimeZoneSensitive(boolean timeZoneSensitive); 356 357 /** 358 * Returns the type of this cal event. 359 * 360 * @return the type of this cal event 361 */ 362 @AutoEscape 363 public String getType(); 364 365 /** 366 * Sets the type of this cal event. 367 * 368 * @param type the type of this cal event 369 */ 370 public void setType(String type); 371 372 /** 373 * Returns the repeating of this cal event. 374 * 375 * @return the repeating of this cal event 376 */ 377 public boolean getRepeating(); 378 379 /** 380 * Returns <code>true</code> if this cal event is repeating. 381 * 382 * @return <code>true</code> if this cal event is repeating; <code>false</code> otherwise 383 */ 384 public boolean isRepeating(); 385 386 /** 387 * Sets whether this cal event is repeating. 388 * 389 * @param repeating the repeating of this cal event 390 */ 391 public void setRepeating(boolean repeating); 392 393 /** 394 * Returns the recurrence of this cal event. 395 * 396 * @return the recurrence of this cal event 397 */ 398 public String getRecurrence(); 399 400 /** 401 * Sets the recurrence of this cal event. 402 * 403 * @param recurrence the recurrence of this cal event 404 */ 405 public void setRecurrence(String recurrence); 406 407 /** 408 * Returns the remind by of this cal event. 409 * 410 * @return the remind by of this cal event 411 */ 412 public int getRemindBy(); 413 414 /** 415 * Sets the remind by of this cal event. 416 * 417 * @param remindBy the remind by of this cal event 418 */ 419 public void setRemindBy(int remindBy); 420 421 /** 422 * Returns the first reminder of this cal event. 423 * 424 * @return the first reminder of this cal event 425 */ 426 public int getFirstReminder(); 427 428 /** 429 * Sets the first reminder of this cal event. 430 * 431 * @param firstReminder the first reminder of this cal event 432 */ 433 public void setFirstReminder(int firstReminder); 434 435 /** 436 * Returns the second reminder of this cal event. 437 * 438 * @return the second reminder of this cal event 439 */ 440 public int getSecondReminder(); 441 442 /** 443 * Sets the second reminder of this cal event. 444 * 445 * @param secondReminder the second reminder of this cal event 446 */ 447 public void setSecondReminder(int secondReminder); 448 449 @Override 450 public boolean isNew(); 451 452 @Override 453 public void setNew(boolean n); 454 455 @Override 456 public boolean isCachedModel(); 457 458 @Override 459 public void setCachedModel(boolean cachedModel); 460 461 @Override 462 public boolean isEscapedModel(); 463 464 @Override 465 public Serializable getPrimaryKeyObj(); 466 467 @Override 468 public void setPrimaryKeyObj(Serializable primaryKeyObj); 469 470 @Override 471 public ExpandoBridge getExpandoBridge(); 472 473 @Override 474 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 475 476 @Override 477 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 478 479 @Override 480 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 481 482 @Override 483 public Object clone(); 484 485 @Override 486 public int compareTo(com.liferay.portlet.calendar.model.CalEvent calEvent); 487 488 @Override 489 public int hashCode(); 490 491 @Override 492 public CacheModel<com.liferay.portlet.calendar.model.CalEvent> toCacheModel(); 493 494 @Override 495 public com.liferay.portlet.calendar.model.CalEvent toEscapedModel(); 496 497 @Override 498 public com.liferay.portlet.calendar.model.CalEvent toUnescapedModel(); 499 500 @Override 501 public String toString(); 502 503 @Override 504 public String toXmlString(); 505 }