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