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