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.messageboards.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 MBMailingList service. Represents a row in the "MBMailingList" 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.messageboards.model.impl.MBMailingListModelImpl} 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.messageboards.model.impl.MBMailingListImpl}.
035     * </p>
036     *
037     * @author Brian Wing Shun Chan
038     * @see MBMailingList
039     * @see com.liferay.portlet.messageboards.model.impl.MBMailingListImpl
040     * @see com.liferay.portlet.messageboards.model.impl.MBMailingListModelImpl
041     * @generated
042     */
043    public interface MBMailingListModel extends BaseModel<MBMailingList>,
044            GroupedModel {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. All methods that expect a message boards mailing list model instance should use the {@link MBMailingList} interface instead.
049             */
050    
051            /**
052             * Returns the primary key of this message boards mailing list.
053             *
054             * @return the primary key of this message boards mailing list
055             */
056            public long getPrimaryKey();
057    
058            /**
059             * Sets the primary key of this message boards mailing list.
060             *
061             * @param primaryKey the primary key of this message boards mailing list
062             */
063            public void setPrimaryKey(long primaryKey);
064    
065            /**
066             * Returns the uuid of this message boards mailing list.
067             *
068             * @return the uuid of this message boards mailing list
069             */
070            @AutoEscape
071            public String getUuid();
072    
073            /**
074             * Sets the uuid of this message boards mailing list.
075             *
076             * @param uuid the uuid of this message boards mailing list
077             */
078            public void setUuid(String uuid);
079    
080            /**
081             * Returns the mailing list ID of this message boards mailing list.
082             *
083             * @return the mailing list ID of this message boards mailing list
084             */
085            public long getMailingListId();
086    
087            /**
088             * Sets the mailing list ID of this message boards mailing list.
089             *
090             * @param mailingListId the mailing list ID of this message boards mailing list
091             */
092            public void setMailingListId(long mailingListId);
093    
094            /**
095             * Returns the group ID of this message boards mailing list.
096             *
097             * @return the group ID of this message boards mailing list
098             */
099            public long getGroupId();
100    
101            /**
102             * Sets the group ID of this message boards mailing list.
103             *
104             * @param groupId the group ID of this message boards mailing list
105             */
106            public void setGroupId(long groupId);
107    
108            /**
109             * Returns the company ID of this message boards mailing list.
110             *
111             * @return the company ID of this message boards mailing list
112             */
113            public long getCompanyId();
114    
115            /**
116             * Sets the company ID of this message boards mailing list.
117             *
118             * @param companyId the company ID of this message boards mailing list
119             */
120            public void setCompanyId(long companyId);
121    
122            /**
123             * Returns the user ID of this message boards mailing list.
124             *
125             * @return the user ID of this message boards mailing list
126             */
127            public long getUserId();
128    
129            /**
130             * Sets the user ID of this message boards mailing list.
131             *
132             * @param userId the user ID of this message boards mailing list
133             */
134            public void setUserId(long userId);
135    
136            /**
137             * Returns the user uuid of this message boards mailing list.
138             *
139             * @return the user uuid of this message boards mailing list
140             * @throws SystemException if a system exception occurred
141             */
142            public String getUserUuid() throws SystemException;
143    
144            /**
145             * Sets the user uuid of this message boards mailing list.
146             *
147             * @param userUuid the user uuid of this message boards mailing list
148             */
149            public void setUserUuid(String userUuid);
150    
151            /**
152             * Returns the user name of this message boards mailing list.
153             *
154             * @return the user name of this message boards mailing list
155             */
156            @AutoEscape
157            public String getUserName();
158    
159            /**
160             * Sets the user name of this message boards mailing list.
161             *
162             * @param userName the user name of this message boards mailing list
163             */
164            public void setUserName(String userName);
165    
166            /**
167             * Returns the create date of this message boards mailing list.
168             *
169             * @return the create date of this message boards mailing list
170             */
171            public Date getCreateDate();
172    
173            /**
174             * Sets the create date of this message boards mailing list.
175             *
176             * @param createDate the create date of this message boards mailing list
177             */
178            public void setCreateDate(Date createDate);
179    
180            /**
181             * Returns the modified date of this message boards mailing list.
182             *
183             * @return the modified date of this message boards mailing list
184             */
185            public Date getModifiedDate();
186    
187            /**
188             * Sets the modified date of this message boards mailing list.
189             *
190             * @param modifiedDate the modified date of this message boards mailing list
191             */
192            public void setModifiedDate(Date modifiedDate);
193    
194            /**
195             * Returns the category ID of this message boards mailing list.
196             *
197             * @return the category ID of this message boards mailing list
198             */
199            public long getCategoryId();
200    
201            /**
202             * Sets the category ID of this message boards mailing list.
203             *
204             * @param categoryId the category ID of this message boards mailing list
205             */
206            public void setCategoryId(long categoryId);
207    
208            /**
209             * Returns the email address of this message boards mailing list.
210             *
211             * @return the email address of this message boards mailing list
212             */
213            @AutoEscape
214            public String getEmailAddress();
215    
216            /**
217             * Sets the email address of this message boards mailing list.
218             *
219             * @param emailAddress the email address of this message boards mailing list
220             */
221            public void setEmailAddress(String emailAddress);
222    
223            /**
224             * Returns the in protocol of this message boards mailing list.
225             *
226             * @return the in protocol of this message boards mailing list
227             */
228            @AutoEscape
229            public String getInProtocol();
230    
231            /**
232             * Sets the in protocol of this message boards mailing list.
233             *
234             * @param inProtocol the in protocol of this message boards mailing list
235             */
236            public void setInProtocol(String inProtocol);
237    
238            /**
239             * Returns the in server name of this message boards mailing list.
240             *
241             * @return the in server name of this message boards mailing list
242             */
243            @AutoEscape
244            public String getInServerName();
245    
246            /**
247             * Sets the in server name of this message boards mailing list.
248             *
249             * @param inServerName the in server name of this message boards mailing list
250             */
251            public void setInServerName(String inServerName);
252    
253            /**
254             * Returns the in server port of this message boards mailing list.
255             *
256             * @return the in server port of this message boards mailing list
257             */
258            public int getInServerPort();
259    
260            /**
261             * Sets the in server port of this message boards mailing list.
262             *
263             * @param inServerPort the in server port of this message boards mailing list
264             */
265            public void setInServerPort(int inServerPort);
266    
267            /**
268             * Returns the in use s s l of this message boards mailing list.
269             *
270             * @return the in use s s l of this message boards mailing list
271             */
272            public boolean getInUseSSL();
273    
274            /**
275             * Returns <code>true</code> if this message boards mailing list is in use s s l.
276             *
277             * @return <code>true</code> if this message boards mailing list is in use s s l; <code>false</code> otherwise
278             */
279            public boolean isInUseSSL();
280    
281            /**
282             * Sets whether this message boards mailing list is in use s s l.
283             *
284             * @param inUseSSL the in use s s l of this message boards mailing list
285             */
286            public void setInUseSSL(boolean inUseSSL);
287    
288            /**
289             * Returns the in user name of this message boards mailing list.
290             *
291             * @return the in user name of this message boards mailing list
292             */
293            @AutoEscape
294            public String getInUserName();
295    
296            /**
297             * Sets the in user name of this message boards mailing list.
298             *
299             * @param inUserName the in user name of this message boards mailing list
300             */
301            public void setInUserName(String inUserName);
302    
303            /**
304             * Returns the in password of this message boards mailing list.
305             *
306             * @return the in password of this message boards mailing list
307             */
308            @AutoEscape
309            public String getInPassword();
310    
311            /**
312             * Sets the in password of this message boards mailing list.
313             *
314             * @param inPassword the in password of this message boards mailing list
315             */
316            public void setInPassword(String inPassword);
317    
318            /**
319             * Returns the in read interval of this message boards mailing list.
320             *
321             * @return the in read interval of this message boards mailing list
322             */
323            public int getInReadInterval();
324    
325            /**
326             * Sets the in read interval of this message boards mailing list.
327             *
328             * @param inReadInterval the in read interval of this message boards mailing list
329             */
330            public void setInReadInterval(int inReadInterval);
331    
332            /**
333             * Returns the out email address of this message boards mailing list.
334             *
335             * @return the out email address of this message boards mailing list
336             */
337            @AutoEscape
338            public String getOutEmailAddress();
339    
340            /**
341             * Sets the out email address of this message boards mailing list.
342             *
343             * @param outEmailAddress the out email address of this message boards mailing list
344             */
345            public void setOutEmailAddress(String outEmailAddress);
346    
347            /**
348             * Returns the out custom of this message boards mailing list.
349             *
350             * @return the out custom of this message boards mailing list
351             */
352            public boolean getOutCustom();
353    
354            /**
355             * Returns <code>true</code> if this message boards mailing list is out custom.
356             *
357             * @return <code>true</code> if this message boards mailing list is out custom; <code>false</code> otherwise
358             */
359            public boolean isOutCustom();
360    
361            /**
362             * Sets whether this message boards mailing list is out custom.
363             *
364             * @param outCustom the out custom of this message boards mailing list
365             */
366            public void setOutCustom(boolean outCustom);
367    
368            /**
369             * Returns the out server name of this message boards mailing list.
370             *
371             * @return the out server name of this message boards mailing list
372             */
373            @AutoEscape
374            public String getOutServerName();
375    
376            /**
377             * Sets the out server name of this message boards mailing list.
378             *
379             * @param outServerName the out server name of this message boards mailing list
380             */
381            public void setOutServerName(String outServerName);
382    
383            /**
384             * Returns the out server port of this message boards mailing list.
385             *
386             * @return the out server port of this message boards mailing list
387             */
388            public int getOutServerPort();
389    
390            /**
391             * Sets the out server port of this message boards mailing list.
392             *
393             * @param outServerPort the out server port of this message boards mailing list
394             */
395            public void setOutServerPort(int outServerPort);
396    
397            /**
398             * Returns the out use s s l of this message boards mailing list.
399             *
400             * @return the out use s s l of this message boards mailing list
401             */
402            public boolean getOutUseSSL();
403    
404            /**
405             * Returns <code>true</code> if this message boards mailing list is out use s s l.
406             *
407             * @return <code>true</code> if this message boards mailing list is out use s s l; <code>false</code> otherwise
408             */
409            public boolean isOutUseSSL();
410    
411            /**
412             * Sets whether this message boards mailing list is out use s s l.
413             *
414             * @param outUseSSL the out use s s l of this message boards mailing list
415             */
416            public void setOutUseSSL(boolean outUseSSL);
417    
418            /**
419             * Returns the out user name of this message boards mailing list.
420             *
421             * @return the out user name of this message boards mailing list
422             */
423            @AutoEscape
424            public String getOutUserName();
425    
426            /**
427             * Sets the out user name of this message boards mailing list.
428             *
429             * @param outUserName the out user name of this message boards mailing list
430             */
431            public void setOutUserName(String outUserName);
432    
433            /**
434             * Returns the out password of this message boards mailing list.
435             *
436             * @return the out password of this message boards mailing list
437             */
438            @AutoEscape
439            public String getOutPassword();
440    
441            /**
442             * Sets the out password of this message boards mailing list.
443             *
444             * @param outPassword the out password of this message boards mailing list
445             */
446            public void setOutPassword(String outPassword);
447    
448            /**
449             * Returns the allow anonymous of this message boards mailing list.
450             *
451             * @return the allow anonymous of this message boards mailing list
452             */
453            public boolean getAllowAnonymous();
454    
455            /**
456             * Returns <code>true</code> if this message boards mailing list is allow anonymous.
457             *
458             * @return <code>true</code> if this message boards mailing list is allow anonymous; <code>false</code> otherwise
459             */
460            public boolean isAllowAnonymous();
461    
462            /**
463             * Sets whether this message boards mailing list is allow anonymous.
464             *
465             * @param allowAnonymous the allow anonymous of this message boards mailing list
466             */
467            public void setAllowAnonymous(boolean allowAnonymous);
468    
469            /**
470             * Returns the active of this message boards mailing list.
471             *
472             * @return the active of this message boards mailing list
473             */
474            public boolean getActive();
475    
476            /**
477             * Returns <code>true</code> if this message boards mailing list is active.
478             *
479             * @return <code>true</code> if this message boards mailing list is active; <code>false</code> otherwise
480             */
481            public boolean isActive();
482    
483            /**
484             * Sets whether this message boards mailing list is active.
485             *
486             * @param active the active of this message boards mailing list
487             */
488            public void setActive(boolean active);
489    
490            public boolean isNew();
491    
492            public void setNew(boolean n);
493    
494            public boolean isCachedModel();
495    
496            public void setCachedModel(boolean cachedModel);
497    
498            public boolean isEscapedModel();
499    
500            public Serializable getPrimaryKeyObj();
501    
502            public void setPrimaryKeyObj(Serializable primaryKeyObj);
503    
504            public ExpandoBridge getExpandoBridge();
505    
506            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
507    
508            public Object clone();
509    
510            public int compareTo(MBMailingList mbMailingList);
511    
512            public int hashCode();
513    
514            public CacheModel<MBMailingList> toCacheModel();
515    
516            public MBMailingList toEscapedModel();
517    
518            public MBMailingList toUnescapedModel();
519    
520            public String toString();
521    
522            public String toXmlString();
523    }