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