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