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.announcements.model;
016    
017    import com.liferay.portal.kernel.bean.AutoEscape;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.model.AttachedModel;
020    import com.liferay.portal.model.AuditedModel;
021    import com.liferay.portal.model.BaseModel;
022    import com.liferay.portal.model.CacheModel;
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 AnnouncementsEntry service. Represents a row in the "AnnouncementsEntry" 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.announcements.model.impl.AnnouncementsEntryModelImpl} 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.announcements.model.impl.AnnouncementsEntryImpl}.
036     * </p>
037     *
038     * @author Brian Wing Shun Chan
039     * @see AnnouncementsEntry
040     * @see com.liferay.portlet.announcements.model.impl.AnnouncementsEntryImpl
041     * @see com.liferay.portlet.announcements.model.impl.AnnouncementsEntryModelImpl
042     * @generated
043     */
044    public interface AnnouncementsEntryModel extends AttachedModel, AuditedModel,
045            BaseModel<AnnouncementsEntry> {
046            /*
047             * NOTE FOR DEVELOPERS:
048             *
049             * Never modify or reference this interface directly. All methods that expect a announcements entry model instance should use the {@link AnnouncementsEntry} interface instead.
050             */
051    
052            /**
053             * Returns the primary key of this announcements entry.
054             *
055             * @return the primary key of this announcements entry
056             */
057            public long getPrimaryKey();
058    
059            /**
060             * Sets the primary key of this announcements entry.
061             *
062             * @param primaryKey the primary key of this announcements entry
063             */
064            public void setPrimaryKey(long primaryKey);
065    
066            /**
067             * Returns the uuid of this announcements entry.
068             *
069             * @return the uuid of this announcements entry
070             */
071            @AutoEscape
072            public String getUuid();
073    
074            /**
075             * Sets the uuid of this announcements entry.
076             *
077             * @param uuid the uuid of this announcements entry
078             */
079            public void setUuid(String uuid);
080    
081            /**
082             * Returns the entry ID of this announcements entry.
083             *
084             * @return the entry ID of this announcements entry
085             */
086            public long getEntryId();
087    
088            /**
089             * Sets the entry ID of this announcements entry.
090             *
091             * @param entryId the entry ID of this announcements entry
092             */
093            public void setEntryId(long entryId);
094    
095            /**
096             * Returns the company ID of this announcements entry.
097             *
098             * @return the company ID of this announcements entry
099             */
100            public long getCompanyId();
101    
102            /**
103             * Sets the company ID of this announcements entry.
104             *
105             * @param companyId the company ID of this announcements entry
106             */
107            public void setCompanyId(long companyId);
108    
109            /**
110             * Returns the user ID of this announcements entry.
111             *
112             * @return the user ID of this announcements entry
113             */
114            public long getUserId();
115    
116            /**
117             * Sets the user ID of this announcements entry.
118             *
119             * @param userId the user ID of this announcements entry
120             */
121            public void setUserId(long userId);
122    
123            /**
124             * Returns the user uuid of this announcements entry.
125             *
126             * @return the user uuid of this announcements entry
127             * @throws SystemException if a system exception occurred
128             */
129            public String getUserUuid() throws SystemException;
130    
131            /**
132             * Sets the user uuid of this announcements entry.
133             *
134             * @param userUuid the user uuid of this announcements entry
135             */
136            public void setUserUuid(String userUuid);
137    
138            /**
139             * Returns the user name of this announcements entry.
140             *
141             * @return the user name of this announcements entry
142             */
143            @AutoEscape
144            public String getUserName();
145    
146            /**
147             * Sets the user name of this announcements entry.
148             *
149             * @param userName the user name of this announcements entry
150             */
151            public void setUserName(String userName);
152    
153            /**
154             * Returns the create date of this announcements entry.
155             *
156             * @return the create date of this announcements entry
157             */
158            public Date getCreateDate();
159    
160            /**
161             * Sets the create date of this announcements entry.
162             *
163             * @param createDate the create date of this announcements entry
164             */
165            public void setCreateDate(Date createDate);
166    
167            /**
168             * Returns the modified date of this announcements entry.
169             *
170             * @return the modified date of this announcements entry
171             */
172            public Date getModifiedDate();
173    
174            /**
175             * Sets the modified date of this announcements entry.
176             *
177             * @param modifiedDate the modified date of this announcements entry
178             */
179            public void setModifiedDate(Date modifiedDate);
180    
181            /**
182             * Returns the fully qualified class name of this announcements entry.
183             *
184             * @return the fully qualified class name of this announcements entry
185             */
186            public String getClassName();
187    
188            public void setClassName(String className);
189    
190            /**
191             * Returns the class name ID of this announcements entry.
192             *
193             * @return the class name ID of this announcements entry
194             */
195            public long getClassNameId();
196    
197            /**
198             * Sets the class name ID of this announcements entry.
199             *
200             * @param classNameId the class name ID of this announcements entry
201             */
202            public void setClassNameId(long classNameId);
203    
204            /**
205             * Returns the class p k of this announcements entry.
206             *
207             * @return the class p k of this announcements entry
208             */
209            public long getClassPK();
210    
211            /**
212             * Sets the class p k of this announcements entry.
213             *
214             * @param classPK the class p k of this announcements entry
215             */
216            public void setClassPK(long classPK);
217    
218            /**
219             * Returns the title of this announcements entry.
220             *
221             * @return the title of this announcements entry
222             */
223            @AutoEscape
224            public String getTitle();
225    
226            /**
227             * Sets the title of this announcements entry.
228             *
229             * @param title the title of this announcements entry
230             */
231            public void setTitle(String title);
232    
233            /**
234             * Returns the content of this announcements entry.
235             *
236             * @return the content of this announcements entry
237             */
238            @AutoEscape
239            public String getContent();
240    
241            /**
242             * Sets the content of this announcements entry.
243             *
244             * @param content the content of this announcements entry
245             */
246            public void setContent(String content);
247    
248            /**
249             * Returns the url of this announcements entry.
250             *
251             * @return the url of this announcements entry
252             */
253            @AutoEscape
254            public String getUrl();
255    
256            /**
257             * Sets the url of this announcements entry.
258             *
259             * @param url the url of this announcements entry
260             */
261            public void setUrl(String url);
262    
263            /**
264             * Returns the type of this announcements entry.
265             *
266             * @return the type of this announcements entry
267             */
268            @AutoEscape
269            public String getType();
270    
271            /**
272             * Sets the type of this announcements entry.
273             *
274             * @param type the type of this announcements entry
275             */
276            public void setType(String type);
277    
278            /**
279             * Returns the display date of this announcements entry.
280             *
281             * @return the display date of this announcements entry
282             */
283            public Date getDisplayDate();
284    
285            /**
286             * Sets the display date of this announcements entry.
287             *
288             * @param displayDate the display date of this announcements entry
289             */
290            public void setDisplayDate(Date displayDate);
291    
292            /**
293             * Returns the expiration date of this announcements entry.
294             *
295             * @return the expiration date of this announcements entry
296             */
297            public Date getExpirationDate();
298    
299            /**
300             * Sets the expiration date of this announcements entry.
301             *
302             * @param expirationDate the expiration date of this announcements entry
303             */
304            public void setExpirationDate(Date expirationDate);
305    
306            /**
307             * Returns the priority of this announcements entry.
308             *
309             * @return the priority of this announcements entry
310             */
311            public int getPriority();
312    
313            /**
314             * Sets the priority of this announcements entry.
315             *
316             * @param priority the priority of this announcements entry
317             */
318            public void setPriority(int priority);
319    
320            /**
321             * Returns the alert of this announcements entry.
322             *
323             * @return the alert of this announcements entry
324             */
325            public boolean getAlert();
326    
327            /**
328             * Returns <code>true</code> if this announcements entry is alert.
329             *
330             * @return <code>true</code> if this announcements entry is alert; <code>false</code> otherwise
331             */
332            public boolean isAlert();
333    
334            /**
335             * Sets whether this announcements entry is alert.
336             *
337             * @param alert the alert of this announcements entry
338             */
339            public void setAlert(boolean alert);
340    
341            public boolean isNew();
342    
343            public void setNew(boolean n);
344    
345            public boolean isCachedModel();
346    
347            public void setCachedModel(boolean cachedModel);
348    
349            public boolean isEscapedModel();
350    
351            public Serializable getPrimaryKeyObj();
352    
353            public void setPrimaryKeyObj(Serializable primaryKeyObj);
354    
355            public ExpandoBridge getExpandoBridge();
356    
357            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
358    
359            public Object clone();
360    
361            public int compareTo(AnnouncementsEntry announcementsEntry);
362    
363            public int hashCode();
364    
365            public CacheModel<AnnouncementsEntry> toCacheModel();
366    
367            public AnnouncementsEntry toEscapedModel();
368    
369            public AnnouncementsEntry toUnescapedModel();
370    
371            public String toString();
372    
373            public String toXmlString();
374    }