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