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