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            @Override
071            public String getUuid();
072    
073            /**
074             * Sets the uuid of this message boards ban.
075             *
076             * @param uuid the uuid of this message boards ban
077             */
078            @Override
079            public void setUuid(String uuid);
080    
081            /**
082             * Returns the ban ID of this message boards ban.
083             *
084             * @return the ban ID of this message boards ban
085             */
086            public long getBanId();
087    
088            /**
089             * Sets the ban ID of this message boards ban.
090             *
091             * @param banId the ban ID of this message boards ban
092             */
093            public void setBanId(long banId);
094    
095            /**
096             * Returns the group ID of this message boards ban.
097             *
098             * @return the group ID of this message boards ban
099             */
100            @Override
101            public long getGroupId();
102    
103            /**
104             * Sets the group ID of this message boards ban.
105             *
106             * @param groupId the group ID of this message boards ban
107             */
108            @Override
109            public void setGroupId(long groupId);
110    
111            /**
112             * Returns the company ID of this message boards ban.
113             *
114             * @return the company ID of this message boards ban
115             */
116            @Override
117            public long getCompanyId();
118    
119            /**
120             * Sets the company ID of this message boards ban.
121             *
122             * @param companyId the company ID of this message boards ban
123             */
124            @Override
125            public void setCompanyId(long companyId);
126    
127            /**
128             * Returns the user ID of this message boards ban.
129             *
130             * @return the user ID of this message boards ban
131             */
132            @Override
133            public long getUserId();
134    
135            /**
136             * Sets the user ID of this message boards ban.
137             *
138             * @param userId the user ID of this message boards ban
139             */
140            @Override
141            public void setUserId(long userId);
142    
143            /**
144             * Returns the user uuid of this message boards ban.
145             *
146             * @return the user uuid of this message boards ban
147             * @throws SystemException if a system exception occurred
148             */
149            @Override
150            public String getUserUuid() throws SystemException;
151    
152            /**
153             * Sets the user uuid of this message boards ban.
154             *
155             * @param userUuid the user uuid of this message boards ban
156             */
157            @Override
158            public void setUserUuid(String userUuid);
159    
160            /**
161             * Returns the user name of this message boards ban.
162             *
163             * @return the user name of this message boards ban
164             */
165            @AutoEscape
166            @Override
167            public String getUserName();
168    
169            /**
170             * Sets the user name of this message boards ban.
171             *
172             * @param userName the user name of this message boards ban
173             */
174            @Override
175            public void setUserName(String userName);
176    
177            /**
178             * Returns the create date of this message boards ban.
179             *
180             * @return the create date of this message boards ban
181             */
182            @Override
183            public Date getCreateDate();
184    
185            /**
186             * Sets the create date of this message boards ban.
187             *
188             * @param createDate the create date of this message boards ban
189             */
190            @Override
191            public void setCreateDate(Date createDate);
192    
193            /**
194             * Returns the modified date of this message boards ban.
195             *
196             * @return the modified date of this message boards ban
197             */
198            @Override
199            public Date getModifiedDate();
200    
201            /**
202             * Sets the modified date of this message boards ban.
203             *
204             * @param modifiedDate the modified date of this message boards ban
205             */
206            @Override
207            public void setModifiedDate(Date modifiedDate);
208    
209            /**
210             * Returns the ban user ID of this message boards ban.
211             *
212             * @return the ban user ID of this message boards ban
213             */
214            public long getBanUserId();
215    
216            /**
217             * Sets the ban user ID of this message boards ban.
218             *
219             * @param banUserId the ban user ID of this message boards ban
220             */
221            public void setBanUserId(long banUserId);
222    
223            /**
224             * Returns the ban user uuid of this message boards ban.
225             *
226             * @return the ban user uuid of this message boards ban
227             * @throws SystemException if a system exception occurred
228             */
229            public String getBanUserUuid() throws SystemException;
230    
231            /**
232             * Sets the ban user uuid of this message boards ban.
233             *
234             * @param banUserUuid the ban user uuid of this message boards ban
235             */
236            public void setBanUserUuid(String banUserUuid);
237    
238            @Override
239            public boolean isNew();
240    
241            @Override
242            public void setNew(boolean n);
243    
244            @Override
245            public boolean isCachedModel();
246    
247            @Override
248            public void setCachedModel(boolean cachedModel);
249    
250            @Override
251            public boolean isEscapedModel();
252    
253            @Override
254            public Serializable getPrimaryKeyObj();
255    
256            @Override
257            public void setPrimaryKeyObj(Serializable primaryKeyObj);
258    
259            @Override
260            public ExpandoBridge getExpandoBridge();
261    
262            @Override
263            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
264    
265            @Override
266            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
267    
268            @Override
269            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
270    
271            @Override
272            public Object clone();
273    
274            @Override
275            public int compareTo(MBBan mbBan);
276    
277            @Override
278            public int hashCode();
279    
280            @Override
281            public CacheModel<MBBan> toCacheModel();
282    
283            @Override
284            public MBBan toEscapedModel();
285    
286            @Override
287            public MBBan toUnescapedModel();
288    
289            @Override
290            public String toString();
291    
292            @Override
293            public String toXmlString();
294    }