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