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