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