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