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.StagedGroupedModel;
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 MBBan service. Represents a row in the "MBBan" 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.MBBanModelImpl} 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.MBBanImpl}.
035     * </p>
036     *
037     * @author Brian Wing Shun Chan
038     * @see MBBan
039     * @see com.liferay.portlet.messageboards.model.impl.MBBanImpl
040     * @see com.liferay.portlet.messageboards.model.impl.MBBanModelImpl
041     * @generated
042     */
043    public interface MBBanModel extends BaseModel<MBBan>, StagedGroupedModel {
044            /*
045             * NOTE FOR DEVELOPERS:
046             *
047             * Never modify or reference this interface directly. All methods that expect a message boards ban model instance should use the {@link MBBan} interface instead.
048             */
049    
050            /**
051             * Returns the primary key of this message boards ban.
052             *
053             * @return the primary key of this message boards ban
054             */
055            public long getPrimaryKey();
056    
057            /**
058             * Sets the primary key of this message boards ban.
059             *
060             * @param primaryKey the primary key of this message boards ban
061             */
062            public void setPrimaryKey(long primaryKey);
063    
064            /**
065             * Returns the uuid of this message boards ban.
066             *
067             * @return the uuid of this message boards ban
068             */
069            @AutoEscape
070            public String getUuid();
071    
072            /**
073             * Sets the uuid of this message boards ban.
074             *
075             * @param uuid the uuid of this message boards ban
076             */
077            public void setUuid(String uuid);
078    
079            /**
080             * Returns the ban ID of this message boards ban.
081             *
082             * @return the ban ID of this message boards ban
083             */
084            public long getBanId();
085    
086            /**
087             * Sets the ban ID of this message boards ban.
088             *
089             * @param banId the ban ID of this message boards ban
090             */
091            public void setBanId(long banId);
092    
093            /**
094             * Returns the group ID of this message boards ban.
095             *
096             * @return the group ID of this message boards ban
097             */
098            public long getGroupId();
099    
100            /**
101             * Sets the group ID of this message boards ban.
102             *
103             * @param groupId the group ID of this message boards ban
104             */
105            public void setGroupId(long groupId);
106    
107            /**
108             * Returns the company ID of this message boards ban.
109             *
110             * @return the company ID of this message boards ban
111             */
112            public long getCompanyId();
113    
114            /**
115             * Sets the company ID of this message boards ban.
116             *
117             * @param companyId the company ID of this message boards ban
118             */
119            public void setCompanyId(long companyId);
120    
121            /**
122             * Returns the user ID of this message boards ban.
123             *
124             * @return the user ID of this message boards ban
125             */
126            public long getUserId();
127    
128            /**
129             * Sets the user ID of this message boards ban.
130             *
131             * @param userId the user ID of this message boards ban
132             */
133            public void setUserId(long userId);
134    
135            /**
136             * Returns the user uuid of this message boards ban.
137             *
138             * @return the user uuid of this message boards ban
139             * @throws SystemException if a system exception occurred
140             */
141            public String getUserUuid() throws SystemException;
142    
143            /**
144             * Sets the user uuid of this message boards ban.
145             *
146             * @param userUuid the user uuid of this message boards ban
147             */
148            public void setUserUuid(String userUuid);
149    
150            /**
151             * Returns the user name of this message boards ban.
152             *
153             * @return the user name of this message boards ban
154             */
155            @AutoEscape
156            public String getUserName();
157    
158            /**
159             * Sets the user name of this message boards ban.
160             *
161             * @param userName the user name of this message boards ban
162             */
163            public void setUserName(String userName);
164    
165            /**
166             * Returns the create date of this message boards ban.
167             *
168             * @return the create date of this message boards ban
169             */
170            public Date getCreateDate();
171    
172            /**
173             * Sets the create date of this message boards ban.
174             *
175             * @param createDate the create date of this message boards ban
176             */
177            public void setCreateDate(Date createDate);
178    
179            /**
180             * Returns the modified date of this message boards ban.
181             *
182             * @return the modified date of this message boards ban
183             */
184            public Date getModifiedDate();
185    
186            /**
187             * Sets the modified date of this message boards ban.
188             *
189             * @param modifiedDate the modified date of this message boards ban
190             */
191            public void setModifiedDate(Date modifiedDate);
192    
193            /**
194             * Returns the ban user ID of this message boards ban.
195             *
196             * @return the ban user ID of this message boards ban
197             */
198            public long getBanUserId();
199    
200            /**
201             * Sets the ban user ID of this message boards ban.
202             *
203             * @param banUserId the ban user ID of this message boards ban
204             */
205            public void setBanUserId(long banUserId);
206    
207            /**
208             * Returns the ban user uuid of this message boards ban.
209             *
210             * @return the ban user uuid of this message boards ban
211             * @throws SystemException if a system exception occurred
212             */
213            public String getBanUserUuid() throws SystemException;
214    
215            /**
216             * Sets the ban user uuid of this message boards ban.
217             *
218             * @param banUserUuid the ban user uuid of this message boards ban
219             */
220            public void setBanUserUuid(String banUserUuid);
221    
222            public boolean isNew();
223    
224            public void setNew(boolean n);
225    
226            public boolean isCachedModel();
227    
228            public void setCachedModel(boolean cachedModel);
229    
230            public boolean isEscapedModel();
231    
232            public Serializable getPrimaryKeyObj();
233    
234            public void setPrimaryKeyObj(Serializable primaryKeyObj);
235    
236            public ExpandoBridge getExpandoBridge();
237    
238            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
239    
240            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
241    
242            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
243    
244            public Object clone();
245    
246            public int compareTo(MBBan mbBan);
247    
248            public int hashCode();
249    
250            public CacheModel<MBBan> toCacheModel();
251    
252            public MBBan toEscapedModel();
253    
254            public MBBan toUnescapedModel();
255    
256            public String toString();
257    
258            public String toXmlString();
259    }